Gerador de sumário Markdown
Cole Markdown ou solte um arquivo .md para obter um sumário aninhado com links compatíveis com o GitHub, pronto para colar de volta no seu documento.
Seu arquivo nunca sai do seu dispositivo.
Solte um arquivo .md aqui, ou
Cole ou envie Markdown para gerar um sumário.
Nenhum título encontrado
Este documento não tem títulos fora de blocos de código, então não há nada para onde linkar.
Sumário
Sobre o gerador de sumário Markdown
Âncoras compatíveis com o GitHub
As âncoras seguem a própria regra do GitHub: o texto do título vira minúsculas, a pontuação é removida e cada espaço restante vira um hífen. Isso significa que os links gerados aqui funcionam ao colar o sumário num README no GitHub ou GitLab — incluindo os detalhes fáceis de errar, como pontuação entre duas palavras deixando um hífen duplo. Títulos repetidos recebem os sufixos -1, -2 do GitHub na ordem do documento, então duas seções chamadas «Visão geral» apontam para os lugares certos.
Os dois estilos de título são encontrados
Títulos ATX (## Título) e setext (texto sublinhado com === ou ---) são ambos coletados. O setext passa despercebido com facilidade — um sublinhado de traços é indistinguível de uma linha horizontal sem olhar a linha acima — então a verificação é compartilhada com nosso formatador e linter para garantir que os três concordem. Títulos dentro de blocos de código cercados ou indentados são ignorados, assim como o front matter YAML.
O aninhamento segue seu documento
A indentação é medida a partir do título menos profundo realmente presente, então um documento cujas seções começam em ## produz uma lista plana de primeiro nível em vez de uma indentada sem motivo. Títulos mais profundos aninham abaixo. Tudo roda localmente no seu navegador — o documento é lido no seu próprio dispositivo e nada é enviado ou armazenado.
Gere sem enviar nada — seu arquivo nunca sai do seu dispositivo
Esta ferramenta roda inteiramente no seu navegador usando JavaScript. Seu Markdown nunca é enviado a um servidor, nunca é armazenado e nunca sai do seu dispositivo — então rascunhos e documentos continuam privados.
Perguntas frequentes
- Os links vão funcionar no GitHub?
- Sim — as âncoras são geradas com a regra de slug do GitHub, então colar o sumário num README produz links funcionais. Isso inclui reproduzir as peculiaridades do GitHub: um título como «Configuração — parte um» produz um hífen duplo onde estava o travessão, porque é o que o GitHub gera.
- Ele encontra títulos sublinhados (setext)?
- Sim. Tanto títulos com # quanto sublinhados com === ou --- são coletados. A mesma verificação de sublinhado versus linha horizontal é compartilhada com o Formatar Markdown e o Lint Markdown, para que as três ferramentas concordem sobre o que conta como título.
- E os títulos duplicados?
- Recebem os sufixos numéricos do GitHub na ordem do documento — a primeira «Visão geral» aponta para #visão-geral e a segunda para #visão-geral-1 — que é exatamente como o renderizador os resolve.
- Existe download?
- Não — um sumário é um trecho que você cola de volta no documento, não um arquivo que guarda. Há um botão de copiar; a caixa de saída também é selecionável, se preferir.
- Títulos dentro de blocos de código entram?
- Não. Blocos cercados e indentados são ignorados, então uma linha com # dentro de um exemplo nunca é confundida com um título. O front matter YAML também é ignorado.
- Meu arquivo é enviado?
- Não. A geração roda inteiramente no seu navegador com JavaScript: seu Markdown nunca é enviado a um servidor e nunca sai do seu dispositivo.
Mais ferramentas de Markdown, em breve
Markdown para PDF, juntar, dividir e mais — tudo grátis e tudo no seu navegador.
Voltar para todas as ferramentas →