Getting Permission
If you'd like to get access to edit the wiki, please get in touch with Derek (email or Discord work best!) and he'll add the permission to your Root Access website account.
Markdown
This wiki uses Markdown, specifically Github Flavored Markdown, with a number of Open Source and custom plugins that extend functionality. The Markdown is parsed with markdown-it-py, with a number of plugins from enabled:
Installed Plugins
mdit-py-plugins
We are using a number of plugins from mdit-py-plugins:
- Admonitions
- Heading Anchors
- Attributes (block and inline)
- Definition Lists
- Footnotes
- Task Lists
Please reference their documentation for the syntax for certain features.
mdit-py-emoji
mdit-py-emoji gives us a syntax for ✨ emoji ✨!
| Example | Output |
|---|---|
:) | 😃 |
:star: | ⭐ |
:metal: | 🤘 |
:yarn: | 🧶 |
...And so on. The full list of conversions can be found in the mdit_py_emoji.
Custom Syntax
We have a few syntax additions that help streamline certain things and make it a little easier to contribute.
Links to other wiki pages
Instead of having to grab the full URL to a wiki page, for example , you can just wrap the target page slug in a couple of square brackets:
| Markdown | Output |
|---|---|
[\[Laser_Cutting]] | Laser Cutting |
^ TODO: FIXME. Because of our the custom wiki link processor works, the example always gets rendered. Remove the \ in between the first two brackets and you'll have the actual wiki code you need.
File Attachments
To display a file on a page, that file must be upload to the page on the editing screen. Once a file is uploaded, it can be referenced in the markdown.
| Description | Markdown | Output |
|---|---|---|
| Display the file URL | filename.txt | filename.txt |
| Display an image |  |  |
| Link to a file | [Get the file!](filename.txt) | Get the file! |
^ TODO: FIXME. We need actual example files before the examples will have the proper output.