Titles and headings
Use markdown headings to structure your documentation and create a clear content hierarchy.Section headers
Best used for section headers.Subsection headers
Best used for subsection headers.Text formatting
We support most markdown formatting. Simply add**, _, or ~ around text to format it.
Basic formatting
| Style | How to write it | Result |
|---|---|---|
| Bold | **bold** | bold |
| Italic | _italic_ | italic |
| Strikethrough | ~strikethrough~ |
**_bold and italic_** to get bold and italic text.
Superscript and subscript
You need to use HTML to write superscript and subscript text. That is, add<sup> or <sub> around your text.
| Text Size | How to write it | Result |
|---|---|---|
| Superscript | <sup>superscript</sup> | superscript |
| Subscript | <sub>subscript</sub> | subscript |
HTML tags work seamlessly within markdown files, giving you additional formatting flexibility when needed.
Linking to pages
You can add a link by wrapping text in[](). You would write [link to google](https://google.com) to link to google.
- Root-relative links
- Relative links
Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path.This links to the page “Text” in the writing-content section.
Blockquotes
Blockquotes are useful for highlighting important information or quotes from external sources.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
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.
Use
> at the start of each line for multiline blockquotes, including empty lines.