Markdown inhoudsopgavegenerator
Genereer een inhoudsopgave voor een Markdown-document. Plak een README- of documentatiepagina, kies welke kopniveaus je wilt opnemen en krijg een geneste lijst met links naar het anker van elke kop, volgens de manier waarop GitHub kop-ID's aanmaakt. Koppen in codeblokken worden overgeslagen en dubbele koppen krijgen genummerde ankers.
Veelgestelde vragen
Hoe worden de ankerlinks gemaakt?
Op dezelfde manier waarop GitHub kop-ID's aanmaakt: de koptekst wordt omgezet naar kleine letters, leestekens en symbolen worden verwijderd en spaties worden koppeltekens. Getting Started wordt #getting-started en C++ & Rust wordt #c--rust.
Wat gebeurt er met koppen die twee keer voorkomen?
Net als op GitHub krijgt de tweede kop met dezelfde tekst -1 achter het anker, de derde -2, enzovoort, zodat elke link naar de juiste sectie verwijst.
Welke koppen worden herkend?
ATX-koppen die beginnen met één tot zes #-tekens en setext-koppen met een onderstreping van = of -. Koppen in afgebakende codeblokken, ingesprongen code en YAML-front matter worden genegeerd.
Hoe wordt opmaak in koppen verwerkt?
Van links blijft alleen de tekst behouden, inline-code verliest de backticks, opmaakmarkeringen en HTML-tags worden verwijderd en afbeeldingen worden weggelaten. Zowel de tekst van de vermelding als het anker worden op basis van deze platte tekst gemaakt.
Welke kopniveaus worden opgenomen?
Standaard niveau 2 en 3, omdat de kop op niveau 1 meestal de documenttitel is. Stel het laagste en hoogste niveau in van 1 tot 6. De lijst springt in op basis van het hoogste gevonden niveau.
Kan ik een genummerde lijst of platte tekst krijgen?
Ja. Kies een genummerde lijst voor 1., 2. en genummerde subniveaus. Schakel links uit om alleen de kopteksten te krijgen, bijvoorbeeld voor een afgedrukte inhoudsopgave.