Markdown-indholdsfortegnelsesgenerator
Generer en indholdsfortegnelse til et Markdown-dokument. Indsæt en README eller dokumentationsside, vælg de overskriftsniveauer, der skal med, og få en indlejret liste med links til hver overskrifts anker, skrevet på samme måde som GitHub opretter overskrifts-id'er. Overskrifter i kodeblokke springes over, og dublerede overskrifter får nummererede ankre.
Ofte stillede spørgsmål
Hvordan oprettes ankerlinks?
På samme måde som GitHub opretter overskrifts-id'er: overskriftsteksten skrives med små bogstaver, tegnsætning og symboler fjernes, og mellemrum bliver til bindestreger. Getting Started bliver til #getting-started, og C++ & Rust bliver til #c--rust.
Hvad sker der med overskrifter, der forekommer flere gange?
Som på GitHub får den anden overskrift med samme tekst -1 føjet til sit anker, den tredje får -2 og så videre, så hvert link peger på det rigtige afsnit.
Hvilke overskrifter genkendes?
ATX-overskrifter, der begynder med et til seks #-tegn, og setext-overskrifter, der er understreget med = eller -. Overskrifter i indhegnede kodeblokke, indrykket kode og YAML-frontmatter ignoreres.
Hvordan håndteres formatering i overskrifter?
Links beholder kun deres tekst, indlejret kode mister sine backticks, fremhævelsesmarkører og HTML-tags fjernes, og billeder udelades. Både indgangsteksten og ankeret dannes ud fra denne almindelige tekst.
Hvilke overskriftsniveauer medtages?
Som standard niveau 2 og 3, fordi niveau 1-overskriften normalt er dokumentets titel. Angiv det laveste og højeste niveau fra 1 til 6. Listen indrykkes i forhold til det højeste niveau, der findes.
Kan jeg få en nummereret liste eller almindelig tekst?
Ja. Vælg en nummereret liste for at få 1., 2. og indlejret nummerering, og slå links fra for kun at få overskriftsteksterne, for eksempel til en udskrevet disposition.