How to use and maintain the wiki
The search function is a bit hidden.
-
Use the search box of Github (likely in the upper left).
-
Type your search term and choose "Search this repository".
-
On the results page choose the "Wiki" tab.
For editing pages in this Wiki, you need to be logged into a Github account.
- Navigate to the page
- Click edit
- The recommended and easiest way to edit this wiki is "Markdown" (in a dropdown above the editor). Tutorials for this can be found here (simple, interactive), here and here (both more detailed, and including Github-specific extras).
There are two ways to create a page. Creating a link first (recommended) or creating a page first.
- When editing a page, you can simply create a link by putting double square brackets around it.
- By clicking the (red) link on the edited page you will open an editing page for the not yet existing page.
- If you save the page, all red links to the page will turn blue.
Creating red links to not-yet-existing pages in a text is a good way to mark TO DOs for pages that should exist.
- In the wiki click "New Page" (somewhere in the upper-right corner)
- When the page is created and finished you can link to it from other pages via a simple link, e.g. in the Markdown editor like this:
Here is the [[new page]]. This will result in a link to the new page.
You can use this article template to structure your wiki article.
- Clone the wiki as a repository with the link provided on the right (e.g. with the Github Desktop Client)
- The articles will be downloaded as text-files (in Markdown) in the project folder.
Export to 'pretty' wiki
Only authorised members of the SMO core team with push access to the page's repository can do that, following the instructions in the README there. Raise an issue there if you think a change from here needs to be urgently reviewed and included in the pretty version.