Gerador de sumário Markdown (índice)

Gere automaticamente um sumário a partir dos títulos (#, ##, ###...) de um documento Markdown.

Exemplo:

Como funciona

Útil para adicionar automaticamente um sumário clicável no topo de um README longo, de um artigo técnico de blog ou de uma documentação Markdown: cole o documento completo, clique em "Gerar sumário" e copie a lista com marcadores obtida para o topo do seu arquivo. Cada entrada aponta para uma âncora `#titulo-slugificado` correspondente ao título, o que funciona diretamente no GitHub, GitLab e na maioria dos motores de renderização Markdown.

Como os títulos são detectados?

A ferramenta procura, linha por linha, linhas começando com um ou mais `#` seguidos de um espaço (o estilo ATX padrão: `# Título`, `## Subtítulo`, etc.). O estilo Markdown alternativo em que um título é sublinhado por `===` ou `---` na linha seguinte não é reconhecido; se você usa esse estilo, converta primeiro seus títulos para a notação `#`.

Como as âncoras dos links são geradas?

Cada título é "slugificado": convertido para minúsculas, a pontuação é removida, e os espaços são substituídos por hífens. Por exemplo, "Etapa 1: Instalação!" se torna a âncora `etapa-1-instalacao`. Se dois títulos idênticos gerarem a mesma âncora, a maioria dos motores Markdown adiciona automaticamente um sufixo numérico (`-1`, `-2`...) ao segundo — vale a pena verificar a renderização final se o seu documento contiver títulos duplicados.

A geração do sumário é executada 100% localmente no seu navegador via WebAssembly: o conteúdo do seu documento nunca sai do seu dispositivo.