Markdown innholdsfortegnelse-generator
Generer automatisk en koblet innholdsfortegnelse fra Markdown-overskriftene dine — perfekt for READMEs, dokumentasjon og lange wikisider.
Markdown-inndata
Generert innholdsfortegnelse
Eksempler på Markdown innholdsfortegnelse
Generer ankerlenker fra overskrifter. Eksempel:
Prosjekthåndbokens overskrifter
Markdown-inndata:
Generert innholdsfortegnelse:
Bruk Eksempel ovenfor for å laste inn flere overskrifter.
Hva er en Markdown innholdsfortegnelse-generator?
En innholdsfortegnelse (TOC) hjelper lesere å navigere i lange dokumenter. I Markdown bruker overskrifter # til ######. En innholdsfortegnelse-generator skanner overskriftene dine og produserer en liste over lenker som hopper til hver seksjon. GitHub Flavored Markdown og mange statiske nettstedsgeneratorer støtter ankerlenker generert fra overskriftstekst.
Dette verktøyet kjører i nettleseren din. Lim inn Markdown eller last opp en fil; innholdsfortegnelsen oppdateres mens du redigerer. Du kan angi minimum og maksimum overskriftsnivåer (f.eks. kun H2–H4). Ankerslugg opprettes fra overskriftstekst og dedupliseres når overskrifter gjentas. For formatering av Markdown, bruk Markdown-formatereren. For konvertering til HTML, bruk Markdown til HTML.
Slik bruker du dette verktøyet
Lim inn eller last opp Markdown
Lim inn Markdown-teksten din i venstre editor eller klikk Last opp for å laste en .md-, .markdown- eller .txt-fil. Bruk Eksempel for å laste eksempeloverskrifter. Innholdsfortegnelsen oppdateres automatisk.
Angi overskriftsnivåintervall
Bruk Min H1–H4 og Maks H3–H6 for å inkludere kun visse overskriftsnivåer. For eksempel hopper Min H2 og Maks H4 over H1 og H5–H6. Dette holder lange dokumenter fokusert.
Kopier eller last ned innholdsfortegnelsen
Kopier den genererte innholdsfortegnelsen til utklippstavlen eller last den ned. Lim den inn øverst i README-en eller dokumentet ditt. For linting av Markdown, bruk Markdown-linteren. For syntakshjelp, bruk Markdown jukselapp.
Hvor generering av innholdsfortegnelse hjelper
README-filer på GitHub, dokumentasjonssider og wikier har nytte av en innholdsfortegnelse. Lesere kan hoppe til seksjoner uten å scrolle. CommonMark-spesifikasjonen definerer overskriftssyntaks; GFM og de fleste renderere støtter #anchor-slug-lenker. Statiske generatorer som Eleventy og VitePress autogenererer ofte ankere.
For å lage tabeller fra CSV eller avgrensede data, bruk Markdown tabellgenerator. For en rask syntaksreferanse, bruk Markdown jukselapp. For å konvertere Markdown til HTML, bruk Markdown til HTML.
Ofte stilte spørsmål
Hvordan genereres ankerlenker?
Ankerlenker genereres ved å konvertere overskriftstekst til små bokstaver, erstatte mellomrom med bindestreker og fjerne spesialtegn — i tråd med ankerformatet til GitHub Flavored Markdown. For eksempel blir "Kom i gang" til #kom-i-gang.
Vil TOC-lenkene fungere på GitHub?
Ja — ankerformatet samsvarer med GitHub Flavored Markdown-konvensjonene, så TOC-lenker fungerer korrekt i GitHub README-filer, wikier og pull request-beskrivelser.
Kan jeg velge hvilke overskriftsnivåer som skal inkluderes?
Ja — du kan konfigurere minimum og maksimum overskriftsdybde i TOC. Du kan for eksempel velge å inkludere bare H2 og H3, og hoppe over H1-tittelen på øverste nivå.
Hva hvis overskriftene mine har spesialtegn?
Spesialtegn som #, *, ? og tegnsetting fjernes fra ankerlenker. Emojier fjernes typisk også. Verktøyet håndterer dette automatisk slik at TOC-lenkene dine forblir gyldige.
Relaterte verktøy
Lær mer: CommonMark, CommonMark-spesifikasjon, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.