Formatting

All documentation is written in Markdown. Some extensions beyond the core Markdown spec are available.

Below, you can see examples of all of the plain markdown formatting available to you within project documentation. There are also Shortcodes that you can use for specific scenarios.

H2

H3

H4

Paragraph styles

Text can be bold or italicized or ~~crossed out~~. Text can be inline code. You can also link to external pages (see the shortcodes page if you need to link to internal pages or headings).

Sometimes, you may need to quote something that somebody said.

You can show code in syntax-highlighted code blocks:

1{
2  "foo": "bar",
3  "baz": 123
4}

You can render diagrams with mermaid (although they don’t look very good right now):

graph TD A[Christmas] -->|Get money| B(Go shopping) B --> C{Let me think} C -->|One| D[Laptop] C -->|Two| E[iPhone] C -->|Three| F[fa:fa-car Car]

You may also need to:

Put
Items
In
A
List

Or possibly even:

an
ordered
list

You can add a footnote if you want ¹

You can also define things if needed.:

term: definition
another term: definition

You can have images too:

kitteh

(if you’re including images in your content, you may want to be aware of the figure shortcode)

Maybe you need to present data in a table:

Syntax	Description
Header	Title
Paragraph	Text

You can also set alignment within columns:

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

markdown source for reference (click to expand)

 1[//]: # (This is how you write a comment in markdown)
 2
 3## H2
 4### H3
 5#### H4
 6
 7## Paragraph styles
 8
 9Text can be **bold** or _italicized_ or ~~crossed out~~. Text can be `inline code`. You can also [link](https://example.com) to external pages (see the shortcodes page if you need to link to internal pages or headings).
10
11> Sometimes, you may need to quote something that somebody said.
12
13You can show code in syntax-highlighted code blocks:
14
15[//]: # (Note that the slashes preceding the backticks on either side of the fenced code block below must be removed in real content. They had to be escaped to show the source inline like this.)
16
17```json
18{
19  "foo": "bar",
20  "baz": 123
21}
22```
23
24You can render diagrams with mermaid (although they don't look very good right now):
25
26```mermaid
27graph TD
28    A[Christmas] -->|Get money| B(Go shopping)
29    B --> C{Let me think}
30    C -->|One| D[Laptop]
31    C -->|Two| E[iPhone]
32    C -->|Three| F[fa:fa-car Car]
33```
34
35You may also need to:
36* Put
37* Items
38* In
39* A
40* List
41
42Or possibly even:
431. an
442. ordered
453. list
46
47You can add a footnote if you want [^1]
48
49You can also define things if needed.:
50
51**term**
52: definition
53
54**another term**
55: definition
56
57You can have images too:
58
59![kitteh](http://placekitten.com/g/200/300)
60
61(if you're including images in your content, you may want to be aware of the `figure` shortcode)
62
63Maybe you need to present data in a table:
64
65| Syntax | Description |
66| --- | ----------- |
67| Header | Title |
68| Paragraph | Text |
69
70You can also set alignment within columns:
71
72| Syntax      | Description | Test Text     |
73| :---        |    :----:   |          ---: |
74| Header      | Title       | Here's this   |
75| Paragraph   | Text        | And more      |
76
77[^1]: This is the footnote

This is the footnote ↩︎