Getting Permission
Markdown
This wiki uses Markdown, specifically Github Flavored Markdown with a number of customizations.
The Markdown is parsed with markdown-it-py, with a number of plugins from mdit-py-plugins enabled:
- Admonitions
- Heading Anchors
- Attributes (block and inline)
- Definition Lists
- Footnotes
- Task Lists
Additionally, the following plugins are installed:
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 | ![image alt text](filename.jpg) | |
Link to a file | [Get the file!](filename.txt) | Get the file! |
Emoji
⭐ yep, it works! 😃