Input Markdown

TOC generato

Esempi TOC Markdown

Genera link di ancoraggio dalle intestazioni. Esempio:

Intestazioni del manuale di progetto

Input Markdown:

Input

TOC generato:

Output

Usa Esempio sopra per caricare altre intestazioni.

Cos'è un Generatore TOC Markdown?

Un indice (TOC) aiuta i lettori a navigare documenti lunghi. In Markdown, le intestazioni usano da # a ######. Un generatore TOC scansiona le intestazioni e produce un elenco di link che saltano a ogni sezione. GitHub Flavored Markdown e molti generatori di siti statici supportano i link di ancoraggio generati dal testo dell'intestazione.

Questo strumento funziona nel browser. Incolla Markdown o carica un file; il TOC si aggiorna durante la modifica. Puoi impostare livelli di intestazione minimi e massimi (es. solo H2–H4). Gli slug di ancoraggio vengono creati dal testo dell'intestazione e deduplicati per intestazioni ripetute. Per la formattazione Markdown: Formattatore Markdown. Per la conversione in HTML: Markdown in HTML.

Come usare questo strumento

1

Incolla o carica Markdown

Incolla il tuo Markdown nell'editor sinistro o fai clic su Carica per caricare un file .md, .markdown o .txt. Usa Esempio per caricare intestazioni di esempio. Il TOC si aggiorna automaticamente.

2

Imposta il range del livello di intestazione

Usa Min H1–H4 e Max H3–H6 per includere solo certi livelli di intestazione. Ad esempio, Min H2 e Max H4 salta H1 e H5–H6. Questo mantiene i documenti lunghi focalizzati.

3

Copia o scarica il TOC

Copia il TOC generato negli appunti o scaricalo. Incollalo in cima al tuo README o documento. Per il linting Markdown: Linter Markdown. Per aiuto con la sintassi: Cheat Sheet Markdown.

Dove la generazione TOC è utile

I file README su GitHub, i siti di documentazione e i wiki beneficiano di un TOC. I lettori possono passare alle sezioni senza scorrere. La specifica CommonMark definisce la sintassi delle intestazioni; GFM e la maggior parte dei renderer supportano i link #anchor-slug. I generatori statici come Eleventy e VitePress spesso generano ancoraggi automaticamente.

Per creare tabelle da CSV o dati delimitati: Generatore Tabelle Markdown. Per un riferimento rapido alla sintassi: Cheat Sheet Markdown. Per Markdown in HTML: Markdown in HTML.

Domande frequenti

Come vengono generati i link di ancoraggio?

I link di ancoraggio vengono generati convertendo il testo delle intestazioni in minuscolo, sostituendo gli spazi con trattini e rimuovendo i caratteri speciali — seguendo il formato di ancoraggio di GitHub Flavored Markdown. Ad esempio, "Per Iniziare" diventa #per-iniziare.

I link del TOC funzioneranno su GitHub?

Sì — il formato di ancoraggio corrisponde alle convenzioni di GitHub Flavored Markdown, quindi i link TOC funzionano correttamente nei file README, wiki e descrizioni di pull request di GitHub.

Posso scegliere quali livelli di intestazione includere?

Sì — puoi configurare la profondità minima e massima delle intestazioni da includere nel TOC. Ad esempio, potresti voler includere solo H2 e H3, saltando il titolo H1 di primo livello.

Cosa succede se le mie intestazioni contengono caratteri speciali?

I caratteri speciali come #, *, ? e la punteggiatura vengono rimossi dai link di ancoraggio. Anche le emoji vengono tipicamente rimosse. Lo strumento gestisce questo automaticamente in modo che i link TOC rimangano validi.

Strumenti correlati

Per saperne di più: CommonMark, specifica CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.