Gerador de sumário Markdown
Gere um sumário para um documento Markdown. Cole um README ou uma página de documentação, escolha os níveis de título a incluir e obtenha uma lista aninhada com links para a âncora de cada título, no formato usado por GitHub para criar IDs de títulos. Títulos dentro de blocos de código são ignorados, e títulos duplicados recebem âncoras numeradas.
Perguntas frequentes
Como os links de âncora são criados?
Da mesma forma que GitHub cria IDs de títulos: o texto do título é convertido para minúsculas, a pontuação e os símbolos são removidos e os espaços viram hífens. Getting Started vira #getting-started, e C++ & Rust vira #c--rust.
O que acontece com títulos que aparecem mais de uma vez?
Assim como no GitHub, a âncora do segundo título com o mesmo texto recebe -1, a do terceiro recebe -2 e assim por diante, para que cada link aponte para a seção correta.
Quais títulos são reconhecidos?
Títulos ATX que começam com um a seis caracteres # e títulos setext sublinhados com = ou -. Títulos dentro de blocos de código delimitados, código indentado e metadados iniciais YAML são ignorados.
Como é tratada a formatação dentro dos títulos?
Dos links, só o texto é mantido; o código em linha perde as crases, os marcadores de ênfase e as tags HTML são removidos, e as imagens são descartadas. O texto da entrada e a âncora são criados a partir desse texto simples.
Quais níveis de título são incluídos?
Por padrão, os níveis 2 e 3, porque o título de nível 1 costuma ser o título do documento. Defina o nível mais baixo e o mais alto entre 1 e 6. A lista é indentada em relação ao nível mais alto encontrado.
Posso obter uma lista numerada ou texto simples?
Sim. Escolha uma lista numerada para obter 1., 2. e numeração aninhada; desative os links para obter apenas os textos dos títulos, por exemplo, para um esboço impresso.