Input Markdown

Generated TOC

Hva er en Markdown TOC-generator?

Holder du på å bygge dokumentasjon eller en lang README som begynner å bli vanskelig å navigere? En innholdsfortegnelse (TOC) gjør det enkelt for lesere å hoppe til seksjonene de er interessert i. Dette verktøyet skanner Markdown-filen din, finner alle overskrifter (fra H1 til H6), genererer riktige ankerlenker og oppretter en strukturert TOC du kan lime inn øverst i dokumentet.

Generatoren bruker GitHub-kompatibelt ankerformat, så TOC-en din fungerer perfekt på GitHub, GitLab og andre plattformer som rendrer Markdown. Den håndterer overskriftsnivåer intelligent — du kan kontrollere TOC-dybden (vis bare H2-H3, eller inkluder alle nivåer opp til H6), og den genererer automatisk korrekt innrykk og nesting.

TOC-en din er alltid synkronisert med overskriftene dine — ingen flere ødelagte ankerlenker eller utdaterte seksjonsreferanser. Spesialtegn i overskrifter håndteres korrekt og utdataen er klar til å limes inn umiddelbart. Alt skjer i nettleseren din, umiddelbart.

Slik bruker du Markdown TOC-generatoren

Følg disse trinnene for å generere en innholdsfortegnelse fra Markdown-overskrifter. Hvert trinn bruker de faktiske kontrollene på denne siden.

1

Lim inn, last opp eller last inn eksempel

Lim inn Markdown i det venstre panelet Markdown-inndata, eller klikk på Last opp for å laste inn en .md-fil. Klikk på Eksempel for å se eksempel-API-dokumentasjon. Verktøyet skanner overskrifter (fra # til ######).

2

Konfigurer min/maks-nivåer

Bruk nedtrekkslistene Min H og Maks H for å kontrollere hvilke overskriftsnivåer som vises i TOC-en. Utdataen oppdateres umiddelbart. GitHub-kompatible ankerlenker.

3

Kopier eller last ned

Klikk på Kopier eller Last ned for å bruke utdataen. Lim inn øverst i dokumentet ditt. Bruk Tøm for å starte på nytt. All behandling skjer i nettleseren.

Når du faktisk ville brukt dette

README-filer på GitHub

Holder du på å bygge en omfattende README for prosjektet ditt? En TOC hjelper brukere med raskt å finne installasjons-, konfigurasjons-, API-dokumentasjons- og bidragsseksjonene. GitHub rendrer automatisk TOC-en din med fungerende ankerlenker.

Dokumentasjonssider

Store dokumentasjonsprosjekter med 20+ sider trenger struktur. Generer TOC for hver side og bygg en hoved-TOC for hele nettstedet. Lesere navigerer trygt i dokumentasjonen din med tydelig struktur.

Wiki-sider

Bygger du bedriftswikier eller kunnskapsbaser med lange artikler? En TOC øverst på hver side forbedrer brukervennligheten. Fungerer på GitHub Wiki, GitLab Wiki og andre Markdown-baserte wikier.

Langformsinnhold

Blogginnlegg, veiledninger, guider eller ethvert langt Markdown-dokument drar nytte av en TOC. Lesere som raskt skanner kan hoppe direkte til relevante seksjoner. Spesielt nyttig for tekniske veiledninger med flere trinn og seksjoner.

Vanlige spørsmål

Må jeg opprette ankerlenkene manuelt?

Nei. Verktøyet genererer dem automatisk. GitHub, GitLab og de fleste CommonMark-kompatible plattformer oppretter automatisk ankre fra overskrifter, så de genererte TOC-lenkene fungerer umiddelbart uten ekstra arbeid.

Fungerer ankerformatet på alle plattformer?

Generatoren bruker GitHub-kompatibelt ankerformat, det mest bredt støttede formatet. GitHub, GitLab og de fleste andre Markdown-plattformer støtter dette formatet innebygd.

Hvordan håndteres spesialtegn i overskrifter?

Generatoren konverterer automatisk spesialtegn til ankersikre formater. Mellomrom blir bindestreker, store bokstaver blir små, og spesialtegn konverteres eller fjernes. De resulterende ankrene er alltid gyldige.

Kan jeg justere TOC-dybden?

Absolutt. Nedtrekkslisten "Min H" kontrollerer det minimale overskriftsnivået (H1, H2 osv.) og "Maks H" kontrollerer maksimum. Vil du bare ha H2-H3? Sett Min til H2 og Maks til H3. Trenger du en fullstendig TOC? Inkluder alle nivåer fra H1 til H6.

Hva skjer hvis overskriftene mine inneholder tall eller symboler?

De håndteres korrekt. En overskrift som "Trinn 1: Kom i gang" konverteres til et anker som #trinn-1-kom-i-gang. Spesialtegn behandles ifølge standardreglene for Markdown-ankre.

Lagres Markdown-innholdet mitt?

Nei. All TOC-generering skjer i nettleseren din med JavaScript. Markdownen din forlater aldri datamaskinen din. Full personvern og sikkerhet.

Relaterte Markdown-verktøy