Markdown Syntax
A full listing of all the markdown we support
Titles
We support headings in the standard markdown format.
Text Formatting
We support most markdown formatting. Simply add **
, _
, or ~
around text to format it.
Style | How to write it | Result |
---|---|---|
Bold | **bold** | bold |
Italic | _italic_ | italic |
Strikethrough | ~strikethrough~ |
- You can also use bold and italic text.
- We do not support subscript/superscript text.
Links
You can add a link by wrapping text in []()
. You would write [link to google](https://google.com)
to link to google.
Lists
We support both ordered and unordered lists.
Unordered Lists
Use the -
character to create an unordered list. For example:
Ordered Lists
Use numbers followed by a period to create an ordered list. For example:
Blockquotes
Singleline
To create a blockquote, add a >
in front of a paragraph.
Dorothy followed her through many of the beautiful rooms in her castle.
Multiline
To create a blockquote, add a >
in front of each paragraph.
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Emoji
Emoji are supported too, though since we render for print, these will appear in black and white rather than colour.
Equations
Be sure to use the $$
syntax to write multi-line equations in markdown. For example, you can write the quadratic formula like this:
Here’s a more advanced example mixing mixing the $$
and $
format, the latter can be used for in-line formatting:
Where:
- is the wave function of the system.
- is the reduced Planck’s constant.
- is the Hamiltonian operator.
Images
You can add images using the 
syntax. For example, you can write 
.
You can control image sizing using this syntax:
Horizontal lines
You can use the standard markdown syntax for horizontal lines, which is three dashes:
---