Ugrás a tartalomhoz
TextArray
100% helyi

Markdown tartalomjegyzék-generátor

Készíts hivatkozásokkal ellátott tartalomjegyzéket egy Markdown dokumentum címsoraiból, GitHub-stílusú horgonyokkal.

Bemenet
Kimenet

Markdown tartalomjegyzék-generátor

Illessz be egy Markdown dokumentumot, és azonnal hivatkozásokkal ellátott tartalomjegyzéket kapsz. Az eszköz végigmegy a szövegen, megkeresi az ATX címsorokat — a #-tól ######-ig terjedő sorokat —, és beágyazott Markdown listát épít belőlük, amelyet egyből egy README, wikioldal vagy bármilyen dokumentáció elejére illeszthetsz. A kerítéssel jelölt kódblokkokon belüli, címsornak látszó sorokat figyelmen kívül hagyja, így a példakódban szereplő Markdown soha nem kerül be hamis tételként a jegyzékbe.

A horgonyok a GitHub szabályai szerint készülnek: a címsor szövege kisbetűs lesz, a szóközökből kötőjel válik, az írásjelek eltűnnek, az ékezetes betűk viszont megmaradnak — a GitHub is megtartja őket, így egy „Gyakori kérdések" címsor #gyakori-kérdések formában hivatkozható, és a jegyzék a github.com-on, GitLabon és a legtöbb Markdown megjelenítőben azonnal működik. Ha több címsor szövege azonos, a második és a harmadik -1 és -2 utótagot kap, pontosan úgy, ahogy a GitHub számozza őket. A félkövér, dőlt, kódos és hivatkozásos jelölés eltűnik a címkéből; az olvasható szöveg marad.

A Szintek beállítás szabja meg a lista mélységét: az alapértelmezett H2–H3 a legtöbb README-hez illik, a H1–H6 mindent felvesz, a Csak H2 és a H2–H4 pedig a laposabb vagy mélyebb dokumentumokhoz való. A Stílus felsorolás és számozott lista között vált, a Hivatkozások kikapcsolásával horgonyok nélküli, sima szöveges vázlatot kapsz, a Behúzás tabulátorral pedig a szintenkénti két szóközt tabulátorra cseréli — ahogy a repositoryd megszokta.

Minden helyben, a böngésződben fut — a dokumentum sehová nem töltődik fel, így a belső specifikációk és a kiadatlan vázlatok az eszközödön maradnak. A kimenet alatti összegzés a megtalált címsorokat és a jegyzék sorait számolja; az eredményt egy kattintással kimásolhatod vagy letöltheted.

Gyakori kérdések

Milyen címsorokat ismer fel az eszköz?
ATX címsorokat — 1–6 kettőskereszttel és szóközzel kezdődő sorokat, #-tól ######-ig. A ``` kerítések közötti kódblokkokban lévő címsorokat átugorja. A setext címsorokat (=== vagy --- vonallal aláhúzott sor) nem ismeri fel; írd őket # címsorként.
Működni fognak a hivatkozások a GitHubon?
Igen. A horgonyok a GitHub szabályai szerint készülnek — kisbetűk, szóközből kötőjel, írásjelek törölve, ékezetek megtartva —, az ismétlődő címsorok pedig ugyanazokat a -1, -2 utótagokat kapják, amelyeket a GitHub fűz hozzájuk, így a README-be illesztett jegyzék azonnal működik.
Kaphatok számozott listát vagy sima szöveget?
Igen. Állítsd a Stílust Számozott értékre a szintenkénti számlálókkal rendezett listához, és kapcsold ki a Hivatkozásokat a horgonyok nélküli sima vázlathoz. A Behúzás tabulátorral a két szóközt tabulátorra cseréli.
Feltöltődik valahová a dokumentumom?
Nem. Az eszköz teljes egészében a böngésződben fut, és a szöveg soha nem hagyja el az eszközödet.