Headers and Text
Text, title, and styling in standard markdown
Titles
Best used for section headers.
Subtitles
Best used for subsection headers.
Each title and subtitle creates an anchor and appears in the table of contents.
Text Formatting
Common markdown formatting uses **
, _
, or ~
around text:
Style | How to write it | Result |
---|---|---|
Bold | **bold** | bold |
Italic | _italic_ | italic |
Strikethrough | ~strikethrough~ |
Combinations like **_bold and italic_**
create bold and italic text.
For superscript and subscript, use HTML tags:
Text Size | How to write it | Result |
---|---|---|
Superscript | <sup>superscript</sup> | superscript |
Subscript | <sub>subscript</sub> | subscript |
Linking to Pages
Create links with []()
: [link to google](https://google.com)
shows as link to google.
For internal docs, use root-relative paths: [link to text](/content/text)
. Avoid relative links like [link to text](../text)
.
You can validate links using our CLI.
Blockquotes
Add >
for blockquotes:
Dorothy followed her through many of the beautiful rooms in her castle.
For multiline quotes, use multiple >
:
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.
LaTeX
Use $ for inline LaTeX: $(a^2 + b^2 = c^2)$
renders as .
Use $$ for equation blocks:
Line Breaks
Use double enter or <br />
for line breaks:
Was this page helpful?