Headers
Structure your content with headers and share links to specific sections
Headers organize your documentation into scannable sections. They automatically appear in the table of contents and generate shareable anchor links.
Basic Usage
Use standard Markdown headers to structure your content:
## Section Title
Content goes here...
### Subsection
More detailed content...Headers H2 and H3 appear in the right-side Table of Contents, helping readers navigate long pages.
Anchor Links
Every header automatically generates an anchor ID from its text:
| Header | Generated Anchor |
|---|---|
## Getting Started | #getting-started |
## API Reference | #api-reference |
### User Authentication | #user-authentication |
Sharing Header Links
Hover over any H2 or H3 header to reveal a link icon. This makes it easy to share direct links to specific sections:
- Click the link icon to copy the URL to your clipboard
- Click the header text to copy the URL and navigate to that section
The link icon appears in a small bordered box to the left of the header. When you copy a link, the icon briefly changes color to confirm the action.
On mobile devices, the link icon is hidden since there's no hover state. Headers still work normally for navigation.
Linking to Headers
Reference specific sections from other pages using the anchor:
See the [authentication section](/api/overview#authentication) for details.Best Practices
Start with H2 for main sections, H3 for subsections:
## Installation
### Prerequisites
### Quick Install
## Configuration
### Basic Options
### Advanced OptionsAvoid skipping levels (e.g., jumping from H2 to H4).
Short headers are easier to scan:
{/* Good */}
## Authentication
{/* Avoid */}
## How to Set Up Authentication in Your ApplicationCapitalize only the first word and proper nouns:
{/* Good */}
## Getting started with the API
{/* Avoid */}
## Getting Started With The API