How to Add and Edit Pages on the Wiki

The wiki is actually a completely separate git repository of markdown files and images that you can clone by running:

git clone https://github.com/Hyp-ed/hyped-2025.wiki.git

All text wiki files must be in markdown!

Wiki Repository Structure

The directory structure of the wiki does not impact how the wiki pages are displayed. No matter how the files are organised in directories, GitHub will simply display all of the files it finds as one long list of pages.

Please make use of directories where appropriate for maintaining good organisation.

Important directories/files:

• There is an images directory in which all images should be stored. Do not delete this directory.
• _Sidebar.md is another markdown file which contains an indented list of text or links to other wiki pages and is displayed on the right-hand side of the wiki on GitHub. (See the section on the sidebar below.)

Adding pages

When on the web interface, simply click the big green New Page button in the top right. You can also just create a new markdown file in your local repo, commit it, and then push that. As mentioned above, feel free to organize your markdown files in a way that would benefit the organization of the repo since this will not have an effect on presentation.

Note: You must manually add a link to your new page to the sidebar, explained below.

Removing pages

When on the web interface, navigate to the wiki page you want to delete. Click on the Edit button next to the New Page button in the top right. Now simply click the Delete button, again in the top right. Alternatively, just remove the file in your local repo, commit the change, and then push that. Obviously please do not delete other people's wiki pages.

Note: You must manually remove the link to the deleted page in the sidebar, explained below.

Editing pages

When on the web interface, navigate to the wiki page you want to edit. Click on the Edit button next to the New Page button in the top right. You can also just edit the markdown file in your local repo, commit the changes, and then push that. The sidebar does not need to be updated, unless you want to change the location of the page within the sidebar (see the sidebar section below).

Updating the sidebar

This is important. The sidebar is simply a markdown file named _Sidebar.md which contains an indented list of links. These links are primarily links to our own wiki pages, but can be to other webpages as well. Whenever you add/delete or change the location of a page within the sidebar, you must manually update _Sidebar.md. This can be done either in your cloned repo of the wiki, or by clicking the little edit button when you hover over the sidebar in the web interface. It is a simple indented list (indents are two spaces), structured like so:

* [Name of link](url goes here)
* [Root level of sidebar](url goes here)
  * [An indented link](url goes here)
  * [Use two spaces for indents](url goes here)
* Can also just be text, doesn't have to be a link!

Note that since you need a URL, if you add a new page, you can only add it to the sidebar once you publish the page and get the URL to it. (However when you delete a page, you are able to delete the markdown file and delete the link from the sidebar file in the same step.)

Adding images

Since the wiki is just a git repo, we keep all of our images that our wiki markdown pages use inside of the images directory. Within this directory, feel free to create further directories to keep stuff organized, but note this does not have any effect on presentation; it is purely for organization. Note that all of this must be done in a local clone of the repo, since there is no web interface equivalent.

To use an image in a wiki page, simply move your image file somewhere in the images directory, and use the following markdown to display it:

[[/images/path/to/image.jpg | height = 200px]]

You can specify the height of the image, and the width will also be automatically adjusted to scale.

Please do not go crazy on the amount of images you use, since they are quite large files and slow down cloning and pulling of the wiki repo. If you no longer display your image in a wiki page or simply removed the entire wiki page, remember to remove the respective image file! This is done by simply removing the image file, committing the change, and pushing as usual.