Fatos principais
- Categoria
- Conversão e codificação
- Tipos de entrada
- textarea, select, checkbox
- Tipo de saída
- text
- Cobertura de amostras
- 4
- API disponível
- Yes
Visão geral
O Gerador de TOC Markdown é uma ferramenta prática que cria automaticamente sumários estruturados a partir dos cabeçalhos do seu documento Markdown. Ele gera links de âncora compatíveis com o padrão do GitHub, facilitando a navegação em arquivos longos como READMEs, documentações e artigos técnicos.
Quando usar
- •Ao escrever documentações extensas ou arquivos README para repositórios que exigem navegação rápida.
- •Quando você deseja estruturar artigos longos em Markdown com um índice interativo de links internos.
- •Para converter a hierarquia de títulos de um texto Markdown em uma lista organizada em HTML ou Markdown sem precisar criar os links manualmente.
Como funciona
- •Cole o seu texto Markdown no campo de entrada principal.
- •Configure os níveis de cabeçalho desejados (de H1 a H6), o estilo de lista (ordenada ou não) e o recuo.
- •Escolha se deseja incluir links de âncora automáticos e selecione o formato de saída (Markdown, HTML ou ambos).
- •Copie o sumário gerado instantaneamente e cole-o diretamente no início do seu documento.
Casos de uso
Exemplos
1. Sumário para README do GitHub
Desenvolvedor de Software- Contexto
- Um desenvolvedor está finalizando a documentação de uma biblioteca de código aberto e precisa adicionar um índice no topo do arquivo README.md.
- Problema
- O arquivo possui muitos cabeçalhos de H2 a H4, tornando a navegação manual difícil para novos usuários.
- Como usar
- Insere o conteúdo do README no campo de entrada, define o nível mínimo como H2 e o máximo como H4, e mantém a opção de links de âncora ativada.
- Configuração de exemplo
-
markdownInput: "[conteúdo do README]", minLevel: "2", maxLevel: "4", listStyle: "unordered", includeAnchor: true, outputFormat: "markdown" - Resultado
- Um sumário limpo em Markdown com links diretos para cada seção do README, pronto para ser colado no topo do arquivo.
2. Índice HTML para Blog Estático
Produtor de Conteúdo- Contexto
- Um redator técnico escreve artigos longos em Markdown para um blog que renderiza HTML diretamente.
- Problema
- Ele precisa de um sumário estruturado em HTML para colar no template do artigo.
- Como usar
- Insere o artigo em Markdown, altera o formato de saída para "HTML" e escolhe recuo de 4 espaços para manter a hierarquia visual.
- Configuração de exemplo
-
markdownInput: "[artigo em markdown]", minLevel: "1", maxLevel: "3", listStyle: "ordered", indent: "4spaces", outputFormat: "html" - Resultado
- Uma lista ordenada em HTML contendo as âncoras corretas para navegação interna na página do blog.
Testar com amostras
markdown, barcodeHubs relacionados
FAQ
Como os links de âncora são gerados?
Eles seguem o padrão do GitHub, convertendo os cabeçalhos em letras minúsculas, removendo caracteres especiais e substituindo espaços por hífens.
Posso limitar quais níveis de cabeçalho aparecem no sumário?
Sim, você pode definir o nível mínimo (ex: H2) e o nível máximo (ex: H4) nas opções de configuração.
A ferramenta suporta listas ordenadas?
Sim, você pode alternar o estilo de lista entre não ordenada (com marcadores) e ordenada (com numeração).
Quais formatos de saída estão disponíveis?
Você pode exportar o sumário em formato Markdown, HTML puro ou em ambos os formatos combinados.
Preciso instalar alguma extensão para usar o gerador?
Não, a ferramenta funciona inteiramente no navegador, processando o texto localmente de forma instantânea.