Jamdesk Documentation logo

Headers

Structure pages with H2 and H3 headers that auto-populate the right-side table of contents and generate shareable anchor links.

Markdown headers (##, ###) split your page into sections. Jamdesk adds H2 and H3 headers to the right-side table of contents. It also generates a shareable anchor link for every header.

Basic Usage

Use standard Markdown headers to structure your content:

## Section Title

Content goes here...

### Subsection

More detailed content...

The right-side Table of Contents lists H2 and H3 headers. Readers use it to jump between sections of long pages.

Every header generates an anchor ID from its text:

HeaderGenerated Anchor
## Getting Started#getting-started
## API Reference#api-reference
### User Authentication#user-authentication

Hover over any H2 or H3 header to reveal a link icon:

  • 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. The icon briefly changes color to confirm the copy.

Mobile devices have no hover state. The link icon is hidden there. Headers still work for navigation.

Linking to Headers

Reference specific sections from other pages using the anchor:

See the [headings section](/content/mdx-basics#headings) for details.

Best Practices

Start with H2 for main sections, H3 for subsections:

## Installation

### Prerequisites

### Quick Install

## Configuration

### Basic Options

### Advanced Options

Avoid 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 Application

Capitalize only the first word and proper nouns:

{/* Good */}
## Getting started with the API

{/* Avoid */}
## Getting Started With The API

What's Next?

SEO Optimization

Improve discovery and metadata

Frontmatter

Define titles, descriptions, and SEO fields