Markdown-sisällysluettelo-generaattori
Luo automaattisesti linkitetty sisällysluettelo Markdown-otsikoistasi — erinomainen README-tiedostoille, dokumentaatiolle ja pitkille wiki-sivuille.
Markdown-syöte
Generoitu sisällysluettelo
Markdown-sisällysluetteloesimerkkejä
Generoi ankkurilinkkejä otsikoista. Esimerkki:
Projektin käsikirjan otsikot
Markdown-syöte:
Generoitu sisällysluettelo:
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
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.
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.
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 ankkurilinkit generoidaan?
Ankkurilinkit luodaan muuntamalla otsikkojen teksti pieniksi kirjaimiksi, korvaamalla välit viivoilla ja poistamalla erikoismerkit — noudattaen GitHub Flavored Markdown -ankkurimuotoa. Esimerkiksi "Aloittaminen" muuttuu muotoon #aloittaminen.
Toimivatko sisällysluettelolinkit GitHubissa?
Kyllä — ankkurimuoto vastaa GitHub Flavored Markdown -käytäntöjä, joten sisällysluettelolinkit toimivat oikein GitHub README -tiedostoissa, wikeissä ja pull request -kuvauksissa.
Voinko valita, mitkä otsikkotasot sisällytetään?
Kyllä — voit määrittää sisällysluetteloon sisällytettävän otsikkosyvyyden vähimmäis- ja enimmäistason. Voit esimerkiksi sisällyttää vain H2- ja H3-tasot, ohittaen ylimmän tason H1-otsikon.
Mitä tapahtuu, jos otsikoissani on erikoismerkkejä?
Erikoismerkit kuten #, *, ? ja välimerkit poistetaan ankkurilinkeistä. Emojit poistetaan tyypillisesti myös. Työkalu käsittelee tämän automaattisesti, jotta sisällysluettelolinkkisi pysyvät kelvollisina.
Liittyvät työkalut
Lue lisää: CommonMark, CommonMark-spesifikaatio, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.