Gerador de sumário Markdown

Cole seu Markdown ou abra um arquivo .md para gerar um sumário com links. Escolha os níveis de título, confira a prévia e copie o resultado para o README.

Seu Markdown
8 títulos encontradosProcessado no navegador
Documento com sumário

Sumário

Documentação do projeto

Introdução

Guia de instalação e uso do projeto.

Instalação

Requisitos

Configuração

Uso

Configuração

Como contribuir

## Este título faz parte de um exemplo

Continue com este documento

Leve seu Markdown atual para o próximo passo, incluindo as últimas alterações.

Como adicionar um sumário ao README

Para criar um sumário em Markdown, use os títulos que já existem no documento. O gerador monta uma lista com links e recuos para as subseções; depois, basta copiar e colar no arquivo.

01

Abra o Markdown do projeto

Cole o conteúdo no editor ou clique no ícone de abrir arquivo. São aceitos arquivos .md e .markdown de até 5 MB. O exemplo inicial já traz títulos em português para você experimentar.

02

Escolha entre H2, H3 e os demais níveis

Nos campos de nível, selecione de H2 até H3 para listar seções e subseções sem incluir o H1 com o nome do projeto. Quer um sumário mais curto? Selecione de H2 até H2. O intervalo disponível vai de H1 a H6.

03

Confira os links e copie o sumário

Clique nos links da prévia para conferir os destinos. Use o ícone de copiar para obter o sumário em Markdown e cole abaixo da apresentação do README, fora de um bloco de código. Salve o arquivo e confira os links também no local de publicação.

O GitHub já tem um sumário. Por que colocar outro no README?

O menu de títulos do GitHub ajuda a navegar pelo arquivo, mas não insere uma lista de links no texto. Este gerador cria um sumário que você pode colar no próprio README: a lista passa a fazer parte do documento.

Num projeto open source, quem chega ao repositório pode ir direto à instalação ou às orientações para contribuir. Na documentação de uma API, o sumário dá acesso às seções de autenticação e exemplos. No README de um projeto da faculdade, organiza requisitos, configuração e execução.

Ao levar esse Markdown para outro site ou editor, confira os destinos dos links. Cada ambiente pode usar regras diferentes para as âncoras dos títulos.

Dúvidas sobre sumários e links em Markdown

Entenda o que entra no sumário, quando gerar uma nova versão e como conferir as âncoras.

Sumário, índice e TOC são a mesma coisa?

Aqui, sim. Você pode encontrar esta ferramenta como gerador de índice Markdown ou gerador de TOC Markdown; TOC vem de Table of Contents. O resultado é uma lista de links para as seções do texto, sem números de página. Não é um resumo do conteúdo nem um sumário paginado para Word ou normas ABNT.

Por que os links do sumário não funcionam no GitHub?

Veja se algum título foi alterado depois da geração: mudanças de palavras, acentos ou pontuação podem mudar a âncora. Se houver títulos repetidos, a ordem deles também importa para os sufixos dos links. Gere o sumário novamente com o README atual e substitua a lista antiga. Confira se ela está fora de um bloco de código e compare o destino de cada link com a âncora do título no GitHub.

Como incluir só H2 e H3 ou remover o H1 do sumário?

Selecione de H2 até H3 nos campos de nível acima do editor. O título principal em H1 e os níveis H4 a H6 ficam de fora. A seleção vale para o nível inteiro, não para um título isolado. Se uma seção não aparecer, confira também a sintaxe: ## Instalação precisa de um espaço depois dos sinais #. Texto em negrito não conta como título.

Os títulos dentro de blocos de código entram no sumário?

Não. O gerador ignora títulos dentro de blocos de código. No exemplo inicial, a linha com ## dentro do bloco marcado como md não entra na lista. Assim, trechos que ensinam a escrever Markdown não viram seções extras do documento.

Como atualizar o sumário depois de alterar os títulos?

Cole ou abra a versão atual do documento, confira os níveis e copie o novo sumário para substituir o anterior. A prévia acompanha as mudanças feitas nesta página. A lista já colada no README precisa ser substituída por você; a ferramenta não acompanha as edições feitas no repositório ou em outro editor.

Gerador online ou extensão para criar sumário no VS Code?

Para gerar um sumário e colar no arquivo, você pode usar esta página no navegador, sem instalar uma extensão. Se precisa atualizar o sumário automaticamente ao salvar no VS Code, extensões como Markdown All in One atendem a esse fluxo. Esta ferramenta serve para gerar e copiar a lista a partir do texto que você trouxer.

Meu arquivo Markdown é enviado para um servidor?

A geração do sumário acontece no navegador, e o arquivo .md ou .markdown é lido localmente, com limite de 5 MB. O editor também usa o armazenamento da sessão do navegador para recuperar o texto ao recarregar a página, quando esse recurso está disponível.

Posso usar o sumário no GitLab ou em outro editor?

Você pode copiar a lista em Markdown, mas precisa conferir os links no destino: esta ferramenta usa âncoras no estilo GitHub, e outros ambientes podem seguir regras diferentes. No GitLab, considere também o recurso de sumário da própria plataforma. Não presuma que uma marcação como [TOC] funcione em qualquer renderizador Markdown.

Deixe as seções do README a um clique

Traga o Markdown do projeto, escolha os títulos que entram na lista e copie o sumário para o arquivo.