Gerador de sumário em Markdown

Tenha um sumário aninhado e clicável para qualquer documento Markdown.

Roda no seu navegador
Sem uploads
Sem conta

Carregando a ferramenta no navegador…

O que faz: Gerador de sumário em Markdown

Um README, um SOP ou um guia de administração longo precisa de um sumário perto do topo, e mantê-lo sincronizado à mão é fácil de errar. Cole o documento inteiro e o gerador lê todos os títulos, inclusive os sublinhados com === e ---, e escreve uma lista aninhada de links que levam a cada seção.

Escolha a profundidade em Incluir até, de só H2 a todos os níveis. Um único título H1 fica de fora por padrão, porque costuma ser o nome do próprio documento. Ative Sumário numerado para uma estrutura 1., 2., 3., que também serve como mapa rápido dos títulos quando você reorganiza um documento.

Exemplo

Entrada

# Manual do gravador

## Antes de gravar
### Teste do microfone (2 min)
## Edição
### Cortar pausas
## Edição
#### Atalhos de teclado

Resultado

- [Antes de gravar](#antes-de-gravar)
  - [Teste do microfone (2 min)](#teste-do-microfone-2-min)
- [Edição](#edição)
  - [Cortar pausas](#cortar-pausas)
- [Edição](#edição-1)

O título H1 é omitido, o H4 fica abaixo da profundidade padrão H3, os parênteses somem da âncora e o segundo título Edição aponta para #edição-1.

Como usar: Gerador de sumário em Markdown

Cole o documento Markdown inteiro, ou clique em Abrir arquivo para carregar um arquivo .md.
Escolha um nível em Incluir até; Mais opções tem Omitir um título H1 único e Sumário numerado.
Clique em Copiar ou Baixar .md e cole a lista abaixo do título do documento.

Bom saber

GitLab, Bitbucket, Docusaurus e outros renderizadores podem gerar ids diferentes do GitHub para títulos com pontuação ou letras não latinas, então teste alguns links por lá.
Títulos dentro de código cercado são ignorados, como deve ser, mas títulos escritos em HTML puro, como <h2>, também não são detectados.
A lista é um retrato do momento. Quando você renomear ou acrescentar títulos, gere de novo; nada a mantém atualizada.

Perguntas sobre Gerador de sumário em Markdown

Como acrescento um sumário a um README do GitHub?

Cole o README aqui, copie a lista gerada e cole abaixo do título. Cada item leva a uma âncora que o GitHub cria para aquele título. O GitHub também tem um menu de estrutura para arquivos README, mas uma lista dentro do arquivo funciona em qualquer visualizador.

Por que um link do sumário não leva ao título?

Geralmente o título mudou depois que a lista foi feita, ou o seu site gera âncoras de um jeito diferente do GitHub. Gere a lista de novo a partir do texto atual e compare uma âncora com o id que o seu site realmente coloca naquele título.

Um sumário deve incluir títulos H4?

Geralmente não. Os leitores percorrem as seções H2, e o H3 já dá detalhe suficiente para guias longos. Ir mais fundo deixa a lista mais longa do que o conteúdo que ela resume, então mantenha o padrão H3 e escolha H4 ou Todos só em documentos de referência.

Posso numerar o sumário?

Sim. Ative Sumário numerado em Mais opções. Cada nível é numerado a partir de 1 e recuado três espaços, então é renderizado como uma lista ordenada aninhada.