Markdown sisukorra koostaja
Looge Markdown dokumendile sisukord. Kleepige README või dokumentatsiooni leht, valige kaasatavad pealkirjatasemed ja saate pesastatud loendi, kus on lingid iga pealkirja ankrule GitHub loodud pealkirja-ID-de vormingus. Koodiplokkide sees olevaid pealkirju eiratakse ja korduvatele pealkirjadele lisatakse nummerdatud ankrud.
Korduma kippuvad küsimused
Kuidas ankrulingid luuakse?
Pealkirja-ID-d loob GitHub samal viisil: pealkirja tekst muudetakse väiketähtedeks, kirjavahemärgid ja sümbolid eemaldatakse ning tühikud asendatakse sidekriipsudega. „Getting Started” muutub kujule #getting-started ja „C++ & Rust” kujule #c--rust.
Mis juhtub sama pealkirja kordustega?
Nagu GitHub puhul, lisatakse sama tekstiga teise pealkirja ankrule -1, kolmanda omale -2 ja nii edasi, et iga link viitaks õigele jaotisele.
Millised pealkirjad leitakse?
ATX-pealkirjad, mis algavad ühest kuni kuue # märgiga, ning setext-pealkirjad, mille all on = või -. Eiratakse raamitud koodiplokkide sees, taandega koodis ja YAML esiosas olevaid pealkirju.
Kuidas pealkirjade vormindust käsitletakse?
Linkidest jäetakse alles ainult tekst, reasisese koodi tagurpidi ülakomad eemaldatakse, rõhumärgistused ja HTML-märgendid eemaldatakse ning pildid jäetakse välja. Nii loendi kirje tekst kui ka ankur moodustatakse lihttekstist.
Millised pealkirjatasemed kaasatakse?
Vaikimisi tasemed 2 ja 3, sest 1. taseme pealkiri on tavaliselt dokumendi pealkiri. Määrake madalaim ja kõrgeim tase vahemikus 1–6. Loend taandatakse leitud kõrgeima taseme suhtes.
Kas saan nummerdatud loendi või lihtteksti?
Jah. Valige nummerdatud loend, et saada 1., 2. ja pesastatud nummerdus; lülitage lingid välja, et näha ainult pealkirjade tekste, näiteks prinditava ülevaate jaoks.