Generator spisu treści Markdown
Wygeneruj spis treści z linkami z nagłówków dokumentu Markdown, z kotwicami w stylu GitHuba.
Generator spisu treści Markdown
Wklej dokument Markdown, a od razu otrzymasz spis treści z linkami. Narzędzie przeszukuje tekst w poszukiwaniu nagłówków ATX — wierszy zaczynających się od # do ###### — i buduje z nich zagnieżdżoną listę Markdown, gotową do wklejenia na początek README, strony wiki lub dowolnej dokumentacji. Wiersze wyglądające jak nagłówki wewnątrz ogrodzonych bloków kodu są ignorowane, więc przykładowy Markdown w snippetach nigdy nie doda do spisu fałszywej pozycji.
Kotwice powstają według reguł GitHuba: tekst nagłówka jest zamieniany na małe litery, spacje na łączniki, a interpunkcja znika, natomiast litery ze znakami diakrytycznymi zostają — GitHub też je zachowuje, więc nagłówek „Częste pytania” linkuje jako #częste-pytania i spis działa na github.com, GitLabie i w większości edytorów Markdown bez poprawek. Gdy kilka nagłówków ma ten sam tekst, drugi i trzeci dostają przyrostki -1 i -2, dokładnie tak, jak numeruje je GitHub. Pogrubienie, kursywa, kod w wierszu i linki w nagłówku znikają z etykiety; czytelny tekst zostaje.
Opcja Poziomy decyduje o głębokości listy: domyślne H2–H3 pasuje do większości plików README, H1–H6 obejmuje wszystko, a Tylko H2 lub H2–H4 sprawdzają się w płytszych i głębszych dokumentach. Styl przełącza między punktorami a listą numerowaną, wyłączenie opcji Linki daje czysty konspekt tekstowy bez kotwic, a Wcięcia tabulatorami zastępują dwie spacje na poziom tabulatorami — zgodnie ze zwyczajem twojego repozytorium.
Wszystko działa lokalnie w twojej przeglądarce — dokument nigdzie nie jest wysyłany, więc wewnętrzne specyfikacje i niepublikowane szkice zostają na twoim urządzeniu. Podsumowanie pod wynikiem liczy znalezione nagłówki i wiersze spisu; rezultat skopiujesz lub pobierzesz jednym kliknięciem. Czyta też HTML: wklej stronę, a narzędzie pobierze jej znaczniki h1–h6 i użyje jako kotwicy id, które już jest na znaczniku. Opcja „Oznacz problemy struktury” zaznaczy potem każdy nagłówek pomijający poziom oraz każdy nagłówek najwyższego poziomu po pierwszym.