Markdown tartalomjegyzék-generátor
Tartalomjegyzék létrehozása egy Markdown dokumentumhoz. Illesszen be egy README fájlt vagy dokumentációs oldalt, válassza ki a felvenni kívánt címsorszinteket, és készítsen beágyazott listát az egyes címsorok horgonyára mutató hivatkozásokkal, a GitHub címazonosítóinak létrehozási módja szerint. A kódblokkokban lévő címsorok kimaradnak, az ismétlődő címsorok pedig számozott horgonyokat kapnak.
Gyakran ismételt kérdések
Hogyan jönnek létre a horgonyhivatkozások?
Ugyanúgy, ahogy a GitHub létrehozza a címazonosítókat: a címsor szövege kisbetűssé válik, az írásjelek és szimbólumok eltűnnek, a szóközök pedig kötőjelekké alakulnak. A Getting Started címből #getting-started, a C++ & Rust címből pedig #c--rust lesz.
Mi történik a többször szereplő címsorokkal?
A GitHub-hoz hasonlóan a másodszor előforduló, azonos szövegű címsor horgonya -1 utótagot kap, a harmadiké -2-t, és így tovább, így minden hivatkozás a megfelelő szakaszra mutat.
Mely címsorokat ismeri fel?
Az egytől hatig terjedő számú # karakterrel kezdődő ATX-címsorokat, valamint az = vagy - jelekkel aláhúzott setext-címsorokat. A kódkerítésekben vagy behúzott kódblokkokban lévő címsorokat és a YAML előtagi adatokat figyelmen kívül hagyja.
Hogyan kezeli a címsorokon belüli formázást?
A hivatkozásokból csak a szövegük marad meg, a soron belüli kód elveszíti a backtickeket, a kiemelésjelölések és a HTML címkék eltűnnek, a képek pedig kimaradnak. A listaelem szövege és a horgony is ebből az egyszerű szövegből készül.
Mely címsorszintek kerülnek bele?
Alapértelmezés szerint a 2. és 3. szint, mert az 1. szintű címsor általában a dokumentum címe. Állítsa be az alsó és felső szintet 1 és 6 között. A lista behúzása a megtalált legmagasabb szinthez igazodik.
Készíthetek számozott listát vagy egyszerű szöveget?
Igen. Válasszon számozott listát az 1., 2. és a beágyazott számozás megjelenítéséhez; a hivatkozásokat kikapcsolva csak a címszövegek jelennek meg, például nyomtatott vázlathoz.