Headings and Text
Reference for headings, paragraphs, inline styles, links, and spacing in MDX.
Overview
Structure your content with headings, paragraphs, inline emphasis, and links. All standard Markdown text formatting is supported. The page title renders as H1, so body headings typically begin at ##.
Headings
Use # symbols to create headers for structure and navigation:
## Section
### Subsection
#### Detail (use H4 as deepest level)
Paragraphs
Separate paragraphs with a blank line:
This is a paragraph with one idea.
This is another paragraph that advances the topic.
This is a paragraph with one idea.
This is another paragraph that advances the topic.
Inline emphasis
| Style | Syntax | Result |
|---|---|---|
| Bold | **Create project** | Create project |
| Italic | *idempotent* | idempotent |
| Strikethrough | ~~Legacy token~~ | |
| Inline code | `GET /v1/projects` | GET /v1/projects |
| Keyboard | <kbd>Ctrl</kbd> | Ctrl |
Style effects
- Bold - Renders text in strong weight for emphasis
- Italic - Renders text in slanted style for subtle emphasis
Strikethrough- Renders text with line through for deletions/deprecationInline code- Renders text in monospace font with background highlight- Keyboard - Renders text as keyboard keys for shortcuts and commands
Links
Internal links
Use relative slugs rooted at the docs site:
[Quickstart](/getting-started/quickstart)
[Components](/components)
External links
Use absolute URLs:
[Documentation.AI](https://documentation.ai/)
Line breaks and spacing
Paragraph breaks
Leave a blank line between paragraphs:
First paragraph.
Second paragraph.
First paragraph.
Second paragraph.
Manual line breaks
Insert <br /> for controlled breaks within a paragraph:
First line with an intentional break.<br />
Second line continues the same paragraph.
First line with an intentional break.
Second line continues the same paragraph.
Avoid stacking multiple blank lines. Use headings and paragraphs for structure, not repeated breaks.