Markdown reference
Reference for Markdown on this wiki.
This wiki uses an extended version of Markdown to generate pages. Here's a reference for how to do things in this extended Markdown format.
All of the following functionallity is provided entirely by markdown2.
Metadata
Various options may be in the metadata section of the file. Below is all metadata options available.
Name | Usage | Required? |
---|---|---|
title | Sets the page title. Used for links and the page header. | Yes |
subtitle | An additional title, sometimes used as a page description. | No |
notoc | Disables the table of contents, defaults to false(table of contents is shown). | No |
forcetitle | Force the tab title. | No |
desc | Set the page description (open graph and normal meta). | No |
Basic formatting
Usage | Example | Preview |
---|---|---|
Bold | **Bold** | Bold |
Italics | *Italics* | Italics |
Strike | ~~strike-through~~ |
Links and Images
You can add links to pages using the usual Markdown syntax, that being [text to display](https://example.com)
, which renders to text to display.
Images can also be added to pages using Markdown syntax, however, for many cases, the best option is to use <img />
tags, as they allow for flexibility. If you'd like to add a caption, consider using <figure>
instead.
<figure>
<img src="/notanimage.png" alt="Wow! No image!" />
<figcaption>Wow! No image!</figcaption>
</figure>
<img src="/notanimage.png" alt="Wow! No image!" />
Using HTML tags is better because it allows resizing of the image, as well as for <figure>
, allowing a caption to be added (this may have unique stying at some point).
Tables
Tables allow for information to be presented neatly.
| Name | Slug |
|------------------|------------------|
| Tables | tables |
| Basic formatting | basic-formatting |
The above markdown outputs:
Name | Slug |
---|---|
Tables | tables |
Basic formatting | basic-formatting |
Note that tables don't need good formatting to work. This works just fine:
|Name|Slug|
|-|-|
|Tables|tables|
|Basic formatting|basic-formatting|
MathML
This wiki includes a way to render LaTeX equations to MathML. Simply surround LaTeX with $$...$$
or $...$
.
$$
y = \sqrt{x^2*\frac{z^3}{a*2}}+8
$$
TOC Placement
Although it'd be nice if the table of contents were to place itself directly after the first section, it unforchunately doesn't. If you would like to put it there, then you need to use the <place-toc />
tag.
Opening section
<place-toc />
## Next
## 2