Headers and Text
Text, title, and styling in standard markdown
Titles
Best used for section headers.
Subtitles
Best used for subsection headers.
Titles and subtitles create anchors and also show up on the table of contents on the right.
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 combine these. For example, write **_bold and italic_** to get bold and italic text.
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 |
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.
Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, [link to text](/content/text) links to the page “Text” in our components section.
Relative links like [link to text](../text) will open slower because we cannot optimize them as easily.
You can validate broken links in your docs with our CLI.
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
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
Mintlify supports in-line LaTeX by surrounding your LaTeX code with dollar signs ($). For example, $(a^2 + b^2 = c^2)$ will render as .
Equations on their own line can be created with double dollar signs ($$):
Line Breaks
Markdown syntax also recognizes a double enter in your MDX as a linebreak.