Nenhuma entrada ainda.
Sumário com âncoras do GitHub
Este gerador de sumário Markdown cria o índice de um arquivo a partir dos títulos, com links de âncora iguais aos do GitHub e do GitLab. Cole um README e copie o sumário, ou baixe o documento com o sumário já inserido entre marcadores.
Última atualização:
Como funciona
Cole o Markdown
Cole um README, use Abrir arquivo para um .md ou Abrir de URL. Títulos dentro de blocos de código e de comentários HTML são ignorados.
Escolha níveis e estilo
Defina quais níveis de título entram, marcadores ou números, a indentação e âncoras do GitHub ou do GitLab.
Copie ou insira
Copie só a lista ou pegue o documento inteiro: o sumário fica entre os marcadores <!-- toc --> e um bloco de sumário existente é substituído.
Recursos
Âncoras iguais às do GitHub
As âncoras seguem o github-slugger: minúsculas, pontuação removida, espaços viram hífens e títulos repetidos recebem -1, -2 em toda a página.
Rodar de novo sem duplicar
Os marcadores do markdown-toc (<!-- toc -->), do Markdown All in One (<!-- TOC -->) e do doctoc são reconhecidos, então atualizar o índice nunca o duplica.
Texto de link limpo
Negrito, itálico, código em linha e links nos títulos viram só o texto visível, como o título aparece renderizado.
Títulos Setext também
Títulos sublinhados com === ou --- são encontrados, além dos títulos com #.
Confira cada âncora
A aba Âncoras lista cada título com o nível e a #âncora gerada, útil para criar links a partir de outras páginas.
Limites e privacidade
Documentos de até 5 MB; os maiores são processados em um worker em segundo plano, para a digitação continuar fluida. O sumário é gerado no seu navegador e o arquivo nunca é enviado. Saiba mais na página de privacidade.
Perguntas frequentes
Como colocar um sumário no README do GitHub?
Cole o README, mantenha as âncoras do GitHub e o intervalo H2–H3 e baixe o documento. O sumário fica abaixo do título, entre os marcadores <!-- toc -->.
Por que os links do meu índice não funcionam?
As âncoras dependem da plataforma. O GitHub remove a pontuação e mantém hífens duplos; o GitLab junta esses hífens. Escolha a plataforma onde o arquivo será exibido.
Títulos com acento funcionam?
Sim. Como no GitHub, letras acentuadas ficam na âncora: "Instalação" vira #instalação. Só a pontuação é removida.
Como ficam títulos repetidos?
Como no GitHub, o segundo título "Uso" recebe a âncora #uso-1 e o terceiro, #uso-2. Títulos pulados ou ocultos também contam.
Posso atualizar um sumário que já existe?
Sim. Se o documento já tem um sumário entre marcadores conhecidos, só esse bloco é substituído; o resto do arquivo fica idêntico, byte a byte.
Dá para fazer um sumário numerado?
Escolha 1. item em Estilo da lista. Cada nível é numerado separadamente e indentado sob o texto do item pai.
O título do documento deve entrar no sumário?
Normalmente não. Pular o título (primeiro H1) deixa o primeiro H1 de fora, e a lista começa pelas seções.