Essentials

Format Text

Learn how to format text, create headers, and style content.

Headers

Headers organize your content and create navigation anchors. They appear in the table of contents and help users scan your documentation.

Use # symbols to create headers of different levels:

## Main section header
### Subsection header
#### Sub-subsection header

We support most markdown formatting for emphasizing and styling text.

Apply these formatting styles to your text:

Style	Syntax	Example	Result
Bold	`text`	`important note`	important note
Italic	`_text_`	`_emphasis_`	emphasis
Strikethrough	`~text~`	`~deprecated~`	~~deprecated~~

You can combine formatting styles:

**_bold and italic_**
**~~bold and strikethrough~~**

bold and italic

~~bold and strikethrough~~

For mathematical expressions or footnotes, use HTML tags:

Type	Syntax	Example	Result
Superscript	`<sup>text</sup>`	`example<sup>2</sup>`	example²
Subscript	`<sub>text</sub>`	`example<sub>n</sub>`	example_n

Links help users navigate between pages and access external resources.

Link to other pages in your documentation using root-relative paths:

[Quickstart](/docs/getting-started/quickstart)
[Code Blocks](/docs/essentials/code)

For external resources, include the full URL:

[Markdown Guide](https://www.markdownguide.org/)

Blockquotes highlight important information, quotes, or examples within your content.

Add > before text to create a blockquote:

> This is a quote that stands out from the main content.

This is a quote that stands out from the main content.

For longer quotes or multiple paragraphs:

> This is the first paragraph of a multi-line blockquote.
>
> This is the second paragraph, separated by an empty line with `>`.

This is the first paragraph of a multi-line blockquote.

This is the second paragraph, separated by an empty line with >.