Markdown-sisällysluettelo-generaattori

Generoi sisällysluettelolinkit Markdown-otsikoista

Markdown-syöte

Generoitu sisällysluettelo

Markdown-sisällysluetteloesimerkkejä

Generoi ankkurilinkkejä otsikoista. Esimerkki:

Projektin käsikirjan otsikot

Markdown-syöte:

Syöte

Generoitu sisällysluettelo:

Tulos

Käytä Esimerkki-painiketta ladataksesi lisää otsikoita.

Mikä on Markdown-sisällysluettelo-generaattori?

Sisällysluettelo (TOC) auttaa lukijoita navigoimaan pitkissä asiakirjoissa. Markdownissa otsikot käyttävät #-merkkiä ######:ään. Sisällysluettelo-generaattori skannaa otsikot ja tuottaa listan linkkejä, jotka hyppäävät kuhunkin osioon. GitHub Flavored Markdown ja monet staattiset sivugeneraattorit tukevat otsikkotekstistä generoituja ankkurilinkkejä.

Tämä työkalu toimii selaimessasi. Liitä Markdown tai lataa tiedosto; sisällysluettelo päivittyy muokatessasi. Voit asettaa minimi- ja maksimiotsikkotasot (esim. vain H2–H4). Ankkurisijainnit luodaan otsikkotekstistä ja deduplikoidaan, kun otsikot toistuvat. Markdownin muotoiluun käytä Markdown-muotoilutyökalua. HTML:ksi muuntamiseen käytä Markdown HTML:ksi.

Kuinka käyttää tätä työkalua

1

Liitä tai lataa Markdown

Liitä Markdownisi vasempaan editoriin tai klikkaa Lataa ladataksesi .md-, .markdown- tai .txt-tiedoston. Käytä Esimerkki ladataksesi esimerkkiotsikot. Sisällysluettelo päivittyy automaattisesti.

2

Aseta otsikkotasoväli

Käytä Min H1–H4 ja Max H3–H6 sisältääksesi vain tietyt otsikkotasot. Esimerkiksi Min H2 ja Max H4 ohittaa H1:n ja H5–H6:n. Tämä pitää pitkät dokumentit fokusoituina.

3

Kopioi tai lataa sisällysluettelo

Kopioi generoitu sisällysluettelo leikepöydällesi tai lataa se. Liitä se README-tiedostosi tai dokumentin alkuun. Markdownin lintaukseen käytä Markdown-linteriä. Syntaksiohjeita varten käytä Markdown-pikaopasta.

Missä sisällysluettelon generointi auttaa

README-tiedostot GitHubissa, dokumentaatiosivustot ja wikit hyötyvät sisällysluettelosta. Lukijat voivat hypätä osioihin ilman vierittämistä. CommonMark-spesifikaatio määrittelee otsikkosyntaksin; GFM ja useimmat renderöijät tukevat #anchor-slug-linkkejä. Staattiset generaattorit kuten Eleventy ja VitePress usein generoivat ankkurit automaattisesti.

Taulukoiden luomiseen CSV:stä tai erotelluista tiedoista käytä Markdown-taulukko-generaattoria. Nopean syntaksiviitteen saamiseksi käytä Markdown-pikaopasta. Markdownin muuntamiseen HTML:ksi käytä Markdown HTML:ksi.

Usein kysyttyä

Miten ankkurisijainnit luodaan?

Otsikot muunnetaan pieniksi kirjaimiksi, erikoismerkit poistetaan, välit korvataan viivoilla. Toistuvat otsikot saavat numeerisen jälkiliitteen (esim. #intro-1, #intro-2).

Toimiiko se GitHubissa?

Kyllä. GitHub generoi ankkurit otsikoista. Liitä sisällysluettelo README:si alkuun; linkit toimivat renderöidyssä näkymässä.

Sisällytetäänkö koodilohkoissa olevat otsikot?

Ei. Aidattujen koodilohkojen (```) sisällä olevat otsikot ohitetaan, jotta koodiesimerkkejä ei sekoiteta dokumenttirakenteeseen.

Voinko rajoittaa syvyyttä?

Kyllä. Käytä Min/Max-tason avattavia valikkoja. Esimerkiksi Min H2 ja Max H4 tuottaa sisällysluettelon vain H2-, H3- ja H4-otsikoilla.

Lähetetäänkö datani palvelimelle?

Ei. Sisällysluettelon generointi tapahtuu kokonaan selaimessasi. Dataa ei ladata tai tallenneta.

Liittyvät työkalut

Markdown-linter Markdown-muotoilutyokalu Markdown-taulukko-generaattori Markdown HTML:ksi Markdown-pikaopas Markdown-tarkistin JSON-muotoilutyokalu

Lue lisää: CommonMark, CommonMark-spesifikaatio, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.