- Writing Content
- Rich Text
Writing Content
Rich Text
Text, title, and styling in standard markdown
Headers
Headers organize your content and create navigation anchors. They appear in the table of contents and help users scan your documentation.
Creating headers
Use # symbols to create headers of different levels:
## Main section header
### Subsection header
#### Sub-subsection header
Use descriptive, keyword-rich headers that clearly indicate the content that follows. This improves both user navigation and search engine optimization.
Disabling anchor links
By default, headers include clickable anchor links that allow users to link directly to specific sections. You can disable these anchor links using the noAnchor prop in HTML or React headers.
<h2 noAnchor>
Header without anchor link
</h2>
When noAnchor is used, the header will not display the anchor chip and clicking the header text will not copy the anchor link to the clipboard.
Text Formatting
We support most Markdown formatting for emphasizing and styling text.
Basic formatting
Apply these formatting styles to your text:
| Style | Syntax | Example | Result |
|---|---|---|---|
| Bold | **text** | **important note** | important note |
| Italic | _text_ | _emphasis_ | emphasis |
~text~ | ~deprecated feature~ |
Combining formats
You can combine formatting styles:
**_bold and italic_**
**~~bold and strikethrough~~**
*~~italic and strikethrough~~*
bold and italic
bold and strikethrough
italic and strikethrough
Superscript and subscript
For mathematical expressions or footnotes, use HTML tags:
| Type | Syntax | Example | Result |
|---|---|---|---|
| Superscript | <sup>text</sup> | example<sup>2</sup> | example2 |
| Subscript | <sub>text</sub> | example<sub>n</sub> | examplen |
Links
Links help users navigate between pages and access external resources. Use descriptive link text to improve accessibility and user experience.
Internal links
Link to other pages in your documentation using root-relative paths:
[Quickstart](/quickstart)
[Steps](/components/steps)
External links
For external resources, include the full URL:
[Markdown Guide](https://www.markdownguide.org/)
Broken links
You can check for broken links in your documentation using the CLI:
mint broken-links
Blockquotes
Blockquotes highlight important information, quotes, or examples within your content.
Single line blockquotes
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.
Multi-line blockquotes
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
>.
Use blockquotes sparingly to maintain their visual impact and meaning. Consider using callouts for notes, warnings, and other information.
Mathematical expressions
We support LaTeX for rendering mathematical expressions and equations.
Inline math
Use single dollar signs, `--- title: “Rich Text” description: “Text, title, and styling in standard markdown”
Headers
Headers organize your content and create navigation anchors. They appear in the table of contents and help users scan your documentation.
Creating headers
Use PROTECTED_BLOCK_13 symbols to create headers of different levels:
PROTECTED_BLOCK_0
Use descriptive, keyword-rich headers that clearly indicate the content that follows. This improves both user navigation and search engine optimization.
Disabling anchor links
By default, headers include clickable anchor links that allow users to link directly to specific sections. You can disable these anchor links using the PROTECTED_BLOCK_14 prop in HTML or React headers.
When PROTECTED_BLOCK_15 is used, the header will not display the anchor chip and clicking the header text will not copy the anchor link to the clipboard.
Text Formatting
We support most Markdown formatting for emphasizing and styling text.
Basic formatting
Apply these formatting styles to your text:
| Style | Syntax | Example | Result |
|---|---|---|---|
| Bold | PROTECTED_BLOCK_16 | PROTECTED_BLOCK_17 | important note |
| Italic | PROTECTED_BLOCK_18 | PROTECTED_BLOCK_19 | emphasis |
| PROTECTED_BLOCK_20 | PROTECTED_BLOCK_21 |
Combining formats
You can combine formatting styles:
PROTECTED_BLOCK_3
bold and italic
bold and strikethrough
italic and strikethrough
Superscript and subscript
For mathematical expressions or footnotes, use HTML tags:
| Type | Syntax | Example | Result |
|---|---|---|---|
| Superscript | PROTECTED_BLOCK_22 | PROTECTED_BLOCK_23 | example2 |
| Subscript | PROTECTED_BLOCK_24 | PROTECTED_BLOCK_25 | examplen |
Links
Links help users navigate between pages and access external resources. Use descriptive link text to improve accessibility and user experience.
Internal links
Link to other pages in your documentation using root-relative paths:
PROTECTED_BLOCK_4
External links
For external resources, include the full URL:
PROTECTED_BLOCK_5
Broken links
You can check for broken links in your documentation using the CLI:
PROTECTED_BLOCK_6
Blockquotes
Blockquotes highlight important information, quotes, or examples within your content.
Single line blockquotes
Add PROTECTED_BLOCK_26 before text to create a blockquote:
PROTECTED_BLOCK_7
This is a quote that stands out from the main content.
Multi-line blockquotes
For longer quotes or multiple paragraphs:
PROTECTED_BLOCK_8
This is the first paragraph of a multi-line blockquote.
This is the second paragraph, separated by an empty line with PROTECTED_BLOCK_27.
Use blockquotes sparingly to maintain their visual impact and meaning. Consider using callouts for notes, warnings, and other information.
Mathematical expressions
We support LaTeX for rendering mathematical expressions and equations.
Inline math
Use single dollar signs, , for inline mathematical expressions:
The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.
The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.
Block equations
Use double dollar signs, $, for standalone equations:
$
E = mc^2
$
$$ E = mc^2 $$
LaTeX support requires proper mathematical syntax. Refer to the LaTeX documentation for comprehensive syntax guidelines.
Line breaks and spacing
Control spacing and line breaks to improve content readability.
Paragraph breaks
Separate paragraphs with blank lines:
This is the first paragraph.
This is the second paragraph, separated by a blank line.
This is the first paragraph.
This is the second paragraph, separated by a blank line.
Manual line breaks
Use HTML <br /> tags for forced line breaks within paragraphs:
This line ends here.<br />
This line starts on a new line.
This line ends here.
This line starts on a new line.
In most cases, paragraph breaks with blank lines provide better readability than manual line breaks.
Best practices
Content organization
- Use headers to create clear content hierarchy
- Follow proper header hierarchy (don’t skip from H2 to H4)
- Write descriptive, keyword-rich header text
Text formatting
- Use bold for emphasis, not for entire paragraphs
- Reserve italics for terms, titles, or subtle emphasis
- Avoid over-formatting that distracts from content
Links
- Write descriptive link text instead of “click here” or “read more”
- Use root-relative paths for internal links
- Test links regularly to prevent broken references