Command Palette

Search for a command to run...

GE

Generatore TOC Markdown

Genera un sommario collegato dalle intestazioni di Markdown

Che cosa è un Markdown Table of Contents Generator?

Un generatore di indici Markdown legge le intestazioni in un documento Markdown e produce un elenco nidificato di collegamenti che saltano a ciascuna sezione Incolli il tuo Markdown e lo strumento restituisce un blocco pronto per l'uso come un elenco puntato in cui ogni riga è un collegamento `[Heading] (#anchor)` Ti evita di scrivere il contorno a mano e di indovinare l'id di ancoraggio che un renderer assegnerà a ciascuna intestazione.

Il cuore dello strumento è l'ancora slug. GitHub, GitLab e la maggior parte dei generatori di siti statici trasformano un'intestazione come "Getting Started" nell'id `getting-started` riducendo il testo, rimuovendo la punteggiatura e sostituendo gli spazi con trattini Questo generatore applica quella stessa regola, incluso il suffisso numerico (`, `-2`) che GitHub aggiunge quando due intestazioni condividono un slug, quindi i collegamenti che produce risoluzione agli ID esatti che la tua pagina README o docs renderà Si leggono sia le intestazioni ATX (linee che iniziano con ``) sia le intestazioni Setext (testo sottolineato con `=` o `-`), e si ignora qualsiasi #`` che appare all'interno di un blocco di codice recintato Le intestazioni che portano in formato lineare vengono gestite allo stesso modo: un collegamento, un testo in grassetto, un codice in grassetto, o un'immagine all'interno di un'intestazione è ridotta al suo testo semplice per l'ancoraggio per la stessa stringa costruita, quindi è sempre d'accordo.

Tutto viene eseguito nel browser Il Markdown che incolli viene analizzato con JavaScript lato client e non lascia mai il dispositivo, quindi non c'è caricamento, nessun account e nessun tracciamento dei tuoi contenuti Lo strumento funziona offline una volta caricata la pagina, ti consente di scegliere i livelli di intestazione da includere, passare da elenchi puntati a elenchi numerati e controllare il rientro e aggiorna il contorno nel momento in cui cambi un'opzione.

Come utilizzare il generatore TOC Markdown?

  1. Incolla il tuo Markdown

    Rilascia il tuo documento completo Markdown o README nella casella di input Le intestazioni all'interno dei blocchi di codice recintati vengono saltate automaticamente.

  2. Scegli i livelli di intestazione

    Imposta i livelli più superficiali e profondi da includere Una scelta comune è da H2 a H3, che mantiene il contorno leggibile senza elencare ogni sottosezione.

  3. Scegli lo stile dell'elenco

    Passa da un elenco puntato o numerato, attiva o disattiva i collegamenti di ancoraggio e seleziona il rientro a due spazi, quattro spazi o scheda.

  4. Copia l'indice

    Copia il Markdown generato e incollalo vicino alla parte superiore del documento Ogni voce si collega all'ancoraggio dell'intestazione corrispondente.

Caratteristiche principali

  • Ancoraggi compatibili con GitHub

    Slugs corrisponde agli ID dei rendering GitHub, inclusi i suffissi numerici per le intestazioni duplicate, quindi ogni collegamento si risolve correttamente.

  • Filtraggio Livelli

    Includi solo i livelli di intestazione che desideri L'annidamento viene misurato dall'intestazione inclusa più superficiale, quindi un elenco che inizia da H2 rimane a filo a sinistra.

  • Ordinato o non ordinato

    Eseguire un elenco puntato o un elenco numerato con contatori per livello, con collegamenti di ancoraggio opzionali e rientro configurabile.

  • Code-Block Aware

    Le intestazioni scritte all'interno di blocchi di codice recintati vengono ignorate, quindi gli snippet di esempio non trapelano mai nel tuo contorno.

Frequently Asked Questions

Un indice Markdown è un elenco di collegamenti che puntano agli ancoraggi di intestazione all'interno della stessa pagina Ad ogni intestazione in un documento Markdown viene assegnato un id automatico e ad esso salta un collegamento scritto come [Sezione] (#sezione) Questo strumento legge le tue intestazioni, costruisce gli ancoraggi corrispondenti e assembla l'elenco nidificato per te.

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