Gerador TOC Markdown
Gere automaticamente um índice com links a partir dos seus títulos Markdown — ótimo para READMEs, documentação e páginas de wiki longas.
Markdown de entrada
TOC gerado
Exemplos de TOC Markdown
Gerar ligações de âncora a partir de títulos. Exemplo:
Títulos do manual do projecto
Markdown de entrada:
TOC gerado:
Utilize Amostra acima para carregar mais títulos.
O que é um gerador TOC Markdown?
Um índice (TOC) ajuda os leitores a navegar documentos longos. Em Markdown, os títulos usam # até ######. Um gerador TOC analisa os seus títulos e produz uma lista de ligações que saltam para cada secção. GitHub Flavored Markdown e muitos geradores de sites estáticos suportam ligações de âncora geradas a partir do texto do título.
Esta ferramenta executa-se no seu browser. Cole Markdown ou carregue um ficheiro; o TOC actualiza-se ao editar. Pode definir níveis mínimo e máximo de títulos (ex.: apenas H2–H4). Os slugs de âncora são criados a partir do texto do título e deduplicados quando se repetem. Para formatar Markdown: Formatador Markdown. Para converter para HTML: Markdown para HTML.
Como utilizar esta ferramenta
Colar ou carregar Markdown
Cole o seu Markdown no editor da esquerda ou clique em Carregar para carregar um ficheiro .md, .markdown ou .txt. Utilize Amostra para carregar títulos de exemplo. O TOC actualiza-se automaticamente.
Definir intervalo de níveis de título
Utilize Mín H1–H4 e Máx H3–H6 para incluir apenas certos níveis. Por exemplo, Mín H2 e Máx H4 omite H1 e H5–H6. Mantém documentos longos focados.
Copiar ou transferir o TOC
Copie o TOC gerado para a área de transferência ou transfira-o. Cole no início do seu README ou doc. Para lint de Markdown: Linter Markdown. Para ajuda de sintaxe: Guia rápida Markdown.
Quando a geração TOC ajuda
Ficheiros README no GitHub, sites de documentação e wikis beneficiam de um TOC. Os leitores podem saltar para secções sem fazer scroll. A especificação CommonMark define a sintaxe de títulos; GFM e a maioria dos renderizadores suportam ligações #anchor-slug. Geradores estáticos como Eleventy e VitePress frequentemente geram âncoras automaticamente.
Para criar tabelas a partir de CSV ou dados delimitados: Gerador de tabelas Markdown. Para referência de sintaxe: Guia rápida Markdown. Para Markdown para HTML: Markdown para HTML.
Perguntas frequentes
Como são geradas as ligações de âncora?
As ligações de âncora são geradas convertendo o texto dos títulos para minúsculas, substituindo espaços por hífens e removendo caracteres especiais — seguindo o formato de âncora do GitHub Flavored Markdown. Por exemplo, "Primeiros Passos" torna-se #primeiros-passos.
Os links do TOC funcionarão no GitHub?
Sim — o formato de âncora corresponde às convenções do GitHub Flavored Markdown, por isso os links TOC funcionam correctamente em ficheiros README, wikis e descrições de pull requests do GitHub.
Posso escolher quais níveis de título incluir?
Sim — pode configurar a profundidade mínima e máxima dos títulos a incluir no TOC. Por exemplo, pode querer incluir apenas H2 e H3, ignorando o título H1 de nível superior.
O que acontece se os meus títulos tiverem caracteres especiais?
Caracteres especiais como #, *, ? e pontuação são removidos das ligações de âncora. Emojis também são tipicamente removidos. A ferramenta trata disto automaticamente para que os seus links TOC permaneçam válidos.
Ferramentas relacionadas
Saiba mais: CommonMark, especificação CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.