Command Palette

Search for a command to run...

GE

Gerador TOC Markdown

Gere um índice vinculado a partir de títulos Markdown

O que é um gerador de índice Markdown?

Um gerador de índice Markdown lê os títulos em um documento Markdown e produz uma lista aninhada de links que saltam para cada seção Você cola seu Markdown, e a ferramenta retorna um bloco pronto para uso, como uma lista com marcadores onde cada linha é um link ` [Heading] (#anchor).Ele salva você de escrever o esboço à mão e de adivinhar o id âncora que um renderizador atribuirá a cada título.

O coração da ferramenta é a âncora slug. GitHub, GitLab e a maioria dos geradores de sites estáticos transformam um título como "Iniciar" no id `getting-start` baixando o texto, removendo a pontuação e substituindo espaços por hífens Este gerador aplica a mesma regra, incluindo o sufixo numérico (`-1, `-2`) que o GitHub adiciona quando dois títulos compartilham um slug, de modo que os links que ele produz resolvem para os ids exatos que sua página README ou docs renderiz. Ele lê os títulos ATX (linhas que começam com títulos `#`) e Setext (texto sublinhado com `=` ou `-`) e ignora qualquer `#` que apareça dentro de um bloco de código cercado. Os títulos que carregam a formatação em linha são tratados da mesma maneira: um link, texto em negrito, código em negrito ou uma imagem dentro de um título é sempre reduzido para a mesma string, portanto, o texto é sempre definido e o mesmo rótulo é reduzido para a partir da mesma string.

Tudo é executado no seu navegador O Markdown que você colar é analisado com JavaScript do lado do cliente e nunca sai do seu dispositivo, portanto, não há upload, nenhuma conta e nenhum rastreamento do seu conteúdo A ferramenta funciona offline depois que a página é carregada, permite escolher os níveis de cabeçalho a serem incluídos, alternar entre listas com marcadores e numeradas e controlar o recuo e atualiza o esboço no momento em que você altera uma opção.

Como usar o Markdown TOC Generator?

  1. Cole sua marcação

    Deixe cair o seu documento Markdown completo ou README na caixa de entrada Os títulos dentro dos blocos de código cercados são ignorados automaticamente.

  2. Escolha os níveis de cabeçalho

    Defina os níveis mais rasos e profundos para incluir Uma escolha comum é H2 a H3, que mantém o contorno legível sem listar todas as subseções.

  3. Escolha o estilo da lista

    Alterne entre uma lista com marcadores ou numerada, ativar ou desativar os links de âncora e selecionar recuo de dois espaços, quatro espaços ou tabulação.

  4. Copie o índice

    Copie o Markdown gerado e cole-o perto da parte superior do seu documento Cada entrada vincula-se à âncora de cabeçalho correspondente.

Principais características

  • Âncoras compatíveis com GitHub

    Slugs corresponde às renderizações IDs do GitHub, incluindo sufixos numéricos para títulos duplicados, para que cada link seja resolvido corretamente.

  • Filtragem Nível

    Inclua apenas os níveis de cabeçalho que você deseja O aninhamento é medido a partir do cabeçalho incluído mais raso, portanto, uma lista que começa em H2 permanece nivelada à esquerda.

  • Ordenado ou não ordenado

    Saia de uma lista com marcadores ou de uma lista numerada com contadores por nível, com links de âncora opcionais e recuo configurável.

  • Consciente de bloqueio de código

    Os títulos escritos dentro de blocos de código cercados são ignorados, portanto, trechos de exemplo nunca vazam para o seu contorno.

Frequently Asked Questions

Um índice Markdown é uma lista de links que apontam para âncoras de cabeçalho dentro da mesma página Cada cabeçalho em um documento Markdown recebe um id automático, e um link escrito como [Seção] (#seção) salta para ele Esta ferramenta lê seus títulos, constrói as âncoras correspondentes e monta a lista aninhada para você.

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

markdown table of contentsmarkdown toc generatorgenerate tocmarkdown toctable of contents generatorgithub anchor linksreadme tocheading linksmarkdown outline