Jamdesk Documentation logo

Cabeçalhos

Estruture páginas com cabeçalhos H2 e H3 que preenchem automaticamente o sumário à direita e geram links de âncora compartilháveis.

Os cabeçalhos Markdown (##, ###) dividem sua página em seções. O Jamdesk adiciona cabeçalhos H2 e H3 ao sumário à direita. Ele também gera um link de âncora compartilhável para cada cabeçalho.

Uso básico

Use cabeçalhos Markdown padrão para estruturar seu conteúdo:

## Section Title

Content goes here...

### Subsection

More detailed content...

O Sumário à direita lista os cabeçalhos H2 e H3. Os leitores o usam para navegar entre seções de páginas longas.

Cada cabeçalho gera um ID de âncora a partir do seu texto:

CabeçalhoÂncora gerada
## Getting Started#getting-started
## API Reference#api-reference
### User Authentication#user-authentication

Passe o mouse sobre qualquer cabeçalho H2 ou H3 para revelar um ícone de link:

  • Clique no ícone de link para copiar a URL para a área de transferência
  • Clique no texto do cabeçalho para copiar a URL e navegar até essa seção

O ícone de link aparece em uma pequena caixa com borda à esquerda do cabeçalho. O ícone muda brevemente de cor para confirmar a cópia.

Dispositivos móveis não têm estado de hover. O ícone de link fica oculto neles. Os cabeçalhos continuam funcionando para navegação.

Referencie seções específicas a partir de outras páginas usando a âncora:

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

Práticas recomendadas

Comece com H2 para seções principais e H3 para subseções:

## Installation

### Prerequisites

### Quick Install

## Configuration

### Basic Options

### Advanced Options

Evite pular níveis (por exemplo, ir de H2 direto para H4).

Cabeçalhos curtos são mais fáceis de escanear:

{/* Good */}
## Authentication

{/* Avoid */}
## How to Set Up Authentication in Your Application

Escreva em maiúscula apenas a primeira palavra e substantivos próprios:

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

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

O que vem a seguir?

Otimização de SEO

Melhore a descoberta e os metadados

Frontmatter

Defina títulos, descrições e campos de SEO