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.
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.
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.
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.
Introdução e Configuração: veja os links com acentos
Não é preciso tirar os acentos dos títulos. Nesta ferramenta, Introdução gera #introdução e Configuração gera #configuração. As âncoras seguem o estilo GitHub: letras minúsculas, espaços convertidos em hífens e remoção de pontuação.
O exemplo do editor tem duas subseções chamadas Configuração. A segunda recebe o sufixo -1 para que os links tenham destinos distintos. Estes são alguns dos links gerados a partir desse exemplo:
| Título no documento | Link no sumário |
|---|---|
## Introdução | [Introdução](#introdução) |
## Instalação | [Instalação](#instalação) |
### Configuração | [Configuração](#configuração) |
### Configuração | [Configuração](#configuração-1) |
## Como contribuir | [Como contribuir](#como-contribuir) |