This file is designed to help you contribute to the website.

How to edit a page

To edit a page, just find it in the github repository and edit from there, or pull the repository and edit it on your PC. Then push to master:

git push -u origin master

and the action script should push it to the pages website. Don't push to the gh-pages repo as this is the backend for rendering the website etc.

How to create a new page

Add the page to the necessary place in the github repository. Then, add it to the SUMMARY.md file as a member of a nested list in the correct section, and link the page name to the page itself using the following syntax:

* [section name](path/to/section.md)
    * [page name](path/to/page.md)

The indentation between layers is four spaces. Also, make sure there is a space between the asterisk and the page name, or it won't work. It is best if we keep the pages saved in a directory with the same name as the section.

How to create a new section

To create a new section, do the same as you would do to add a new page, but when adding it to the SUMMARY.md file, put it as a top level element in the list:

* [new section name](path/to/section.md)

When you've created a new section page, also create a new directory in which files relating to that section can be stored.

How to edit and preview locally

To preview the website quickly you can build and host it locally. On Linux this requires you to install gitbook-cli which can be accomplished using the commands

sudo apt install npm
sudo npm install -g gitbook-cli

Assuming the wiki is in the folder ./wiki/ then you can the plugins listed in ./wiki/book.json using the command

gitbook install ./wiki/

Finally, you can start hosting the website locally using the command

gitbook serve ./wiki/

With the website hosted locally saved changes cause the website to refresh and thus appear instantly.