Headers and Text

Updated on

Titles

Best used for section headers.

## Titles

Subtitles

Best use to subsection headers.

### Subtitles

Each title and subtitle creates an anchor also shows up on the table of contents on the right.

Text Formatting

We support most markdown formatting. Simply add **, _, or ~ around text to format it.

StyleHow to write itResult
Bold**bold**bold
Italic_italic_italic
Strikethrough~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 SizeHow to write itResult
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.

Block quotes

Single line

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.

Multi line

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.

Line breaks

Add a line break. Markdown syntax also recognizes a double enter in your MDX as a line break.

<br />
Paragraph 1
Paragraph 2