Gerador de Índice Markdown
Uma ferramenta gratuita para gerar automaticamente um Índice (TOC) a partir de texto Markdown.
Personalize níveis e formatos. Funciona de forma segura no seu navegador.
Sobre o Gerador de Índice Markdown
Uma ferramenta gratuita que gera automaticamente um Índice (TOC) para documentos escritos em Markdown. Economiza o trabalho de criar manualmente um índice ao escrever artigos técnicos para plataformas como READMEs do GitHub ou blogs.
Você pode personalizar finamente o intervalo de extração de níveis de cabeçalho (h1-h6) e o formato de saída, como listas não ordenadas (-) ou listas ordenadas (1.).
Todo o processamento é concluído dentro do seu navegador, portanto, os dados de texto que você insere nunca são enviados a um servidor externo. Você pode usá-lo com segurança para documentos confidenciais ou notas particulares sem se preocupar com vazamentos de informações.
Como usar
Insira o Markdown
Cole ou digite o texto Markdown para o qual deseja criar um índice na área de entrada esquerda.
Defina Opções
Selecione o "Nível Máximo (h2-h6)" a ser extraído e o "Formato da Lista (Não ordenada / Ordenada)" a ser gerado.
Gere e Copie o Índice
Clique no botão "Gerar Índice" e o índice aparecerá na área direita. Clique no botão de copiar e cole em seu documento original.
Glossário
- Markdown
- Uma linguagem de marcação leve para formatação de texto. Usa símbolos para expressar facilmente cabeçalhos, listas, links, etc., e é amplamente utilizada, especialmente entre programadores.
- TOC (Índice)
- Colocado no início de um documento longo, permite que os leitores acessem rapidamente a seção desejada, melhorando a legibilidade.
- Nível de Cabeçalho
- Um indicador da estrutura hierárquica de um documento, correspondendo às tags h1 a h6 do HTML. No Markdown, o nível é expresso pelo número de "#"s.
- Link de Âncora
- Um link para pular para um local específico em uma página. Em um índice Markdown, ele pula especificando um ID gerado automaticamente (ex: `#cabeçalho`) com base no texto do cabeçalho.
- Processamento do Lado do Cliente
- Um mecanismo que executa um programa apenas dentro do navegador do usuário sem se comunicar com um servidor. Não apresenta risco de vazamento de dados e oferece excelente segurança.
Perguntas frequentes
- Q.Os dados Markdown que eu insiro são salvos no servidor?
- Não, não são salvos. Como esta ferramenta usa processamento do lado do cliente que é executado inteiramente dentro do seu navegador, o texto que você insere nunca é enviado a um servidor externo. Você pode usá-la com segurança até mesmo para documentos contendo informações confidenciais.
- Q.Clicar no link do índice gerado não pula.
- Dependendo da plataforma (GitHub, etc.), as regras para gerar IDs de âncora automaticamente a partir dos cabeçalhos podem variar. Esta ferramenta gera IDs baseados em regras comuns (letras minúsculas, substituindo espaços por hifens, etc.), mas você pode precisar modificá-los manualmente para se adequar às especificações da plataforma.
- Q.Posso excluir um cabeçalho específico do índice?
- Na versão atual, todos os cabeçalhos abaixo do 'Nível Máximo' especificado são extraídos. Não há recurso para excluir apenas cabeçalhos específicos, portanto, exclua-os manualmente após a geração.
- Q.Os '#' dentro de blocos de código também são extraídos?
- Não, nosso algoritmo de extração é projetado para ignorar texto dentro de blocos de código cercados por três crases (```). Portanto, comentários dentro do código não serão extraídos por engano como um índice.
- Q.Ele suporta cabeçalhos que não estão em inglês?
- Sim. Cabeçalhos em japonês, inglês e outros idiomas serão extraídos corretamente e gerados como um índice. No entanto, como a regra de geração de ID de link de âncora é baseada no inglês, os cabeçalhos que não estão em inglês podem ser codificados em URL em alguns casos.
Casos de uso
Criação de READMEs do GitHub
Adicione um índice a arquivos README.md longos para projetos de código aberto para facilitar a localização de informações por contribuidores e usuários.
Escrita de Blogs Técnicos
Ao postar artigos técnicos longos em plataformas, coloque um índice no início para aumentar a conveniência do leitor.
Organização de Documentos Internos
Adicione um índice aos manuais internos criados com ferramentas compatíveis com Markdown, como o Notion, para melhorar a capacidade de pesquisa e a legibilidade.
Organização de Notas Pessoais
Adicione um índice à enorme quantidade de anotações acumuladas em ferramentas de gerenciamento de conhecimento como Obsidian ou Logseq para organizar seus pensamentos e revisá-los perfeitamente.
Enviar feedback
Deixe-nos saber sua opinião para nos ajudar a melhorar a ferramenta.
O feedback está temporariamente suspenso
O servidor está ocupado ou a proteção contra spam está ativa. Tente novamente mais tarde.