Markdown Syntax
Text, title, and styling in standard markdown
Best used for section headers.
## Titles
SubtitlesPermalink for this section
Best use to subsection headers.
### Subtitles
Text FormattingPermalink for this section
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 PagesPermalink for this section
You can add a link by wrapping text in [](). You would write [link to google](https://google.com) to link to google (opens in a new tab).
Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, [link to text](/writing-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.
BlockquotesPermalink for this section
SinglelinePermalink for this section
To create a blockquote, add a > in front of a paragraph.
Dorothy followed her through many of the beautiful rooms in her castle.
> Dorothy followed her through many of the beautiful rooms in her castle.
MultilinePermalink for this section
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.
> 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.
LaTeXPermalink for this section
Nextra supports LaTeX (opens in a new tab), check the Nextra docs (opens in a new tab) for more information.
MermaidPermalink for this section
Nextra supports Mermaid (opens in a new tab) out of the box, check the Nextra docs (opens in a new tab) for more information.
Npm2YarnPermalink for this section
Nextra uses
@theguild/remark-npm2yarn (opens in a new tab)
package that replaces the code block that has npm2yarn metadata with
<Tabs /> and <Tab /> components from
nextra/components.
FootnotesPermalink for this section
Footnote. 1
FootnotesPermalink for this section
-
The footnote value. ↩