Cabeçalhos
Estruture páginas com cabeçalhos H2 e H3 que preenchem automaticamente o índice à direita e geram links de âncora compartilháveis.
Os cabeçalhos Markdown (##, ###) dividem sua página em seções que os leitores podem analisar rapidamente. O Jamdesk identifica cabeçalhos H2 e H3 para o índice do lado direito e gera links de âncora que você pode compartilhar diretamente.
Uso básico
Use cabeçalhos Markdown padrão para estruturar seu conteúdo:
## Section Title
Content goes here...
### Subsection
More detailed content...Os cabeçalhos H2 e H3 aparecem no Table of Contents do lado direito para que os leitores possam navegar entre as seções de páginas longas.
Links de âncora
Cada cabeçalho gera automaticamente um ID de âncora a partir de seu texto:
| Cabeçalho | Âncora gerada |
|---|---|
## Getting Started | #getting-started |
## API Reference | #api-reference |
### User Authentication | #user-authentication |
Compartilhar links de cabeçalho
Passe o cursor sobre qualquer cabeçalho H2 ou H3 para exibir um ícone de link. Isso facilita o compartilhamento de links diretos para seções específicas:
- 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. Ao copiar um link, o ícone muda brevemente de cor para confirmar a ação.
Em dispositivos móveis, o ícone de link fica oculto porque não há estado de passagem do cursor. Os cabeçalhos continuam funcionando normalmente para navegação.
Criar links para cabeçalhos
Faça referência a seções específicas 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 OptionsEvite pular níveis (por exemplo, passar de H2 para H4).
Cabeçalhos curtos são mais fáceis de analisar:
{/* Good */}
## Authentication
{/* Avoid */}
## How to Set Up Authentication in Your ApplicationColoque em maiúscula apenas a primeira palavra e os nomes próprios:
{/* Good */}
## Getting started with the API
{/* Avoid */}
## Getting Started With The API