Generator spisu treści Markdown
Wygeneruj spis treści dokumentu Markdown. Wklej stronę README lub stronę dokumentacji, wybierz uwzględniane poziomy nagłówków i otrzymaj zagnieżdżoną listę z linkami do kotwic każdego nagłówka, utworzonymi w sposób stosowany przez GitHub do nadawania identyfikatorów nagłówkom. Nagłówki w blokach kodu są pomijane, a powtarzające się nagłówki otrzymują numerowane kotwice.
Najczęściej zadawane pytania
Jak tworzone są linki do kotwic?
Tak samo jak GitHub tworzy identyfikatory nagłówków: tekst nagłówka jest zamieniany na małe litery, znaki interpunkcyjne i symbole są usuwane, a spacje zastępowane łącznikami. Getting Started zmienia się w #getting-started, a C++ & Rust w #c--rust.
Co dzieje się z nagłówkami o identycznej treści?
Podobnie jak w GitHub, do kotwicy drugiego nagłówka o tej samej treści dodawane jest -1, do kotwicy trzeciego -2 i tak dalej, dzięki czemu każdy link prowadzi do właściwej sekcji.
Które nagłówki są rozpoznawane?
Nagłówki ATX rozpoczynające się od jednego do sześciu znaków # oraz nagłówki setext podkreślone za pomocą = lub -. Nagłówki wewnątrz bloków kodu z ogranicznikami, kodu z wcięciami i nagłówki w sekcji front matter YAML są pomijane.
Jak obsługiwane jest formatowanie wewnątrz nagłówków?
Z linków pozostaje tylko ich tekst, z kodu inline usuwane są odwrotne apostrofy, znaczniki wyróżnienia i znaczniki HTML są usuwane, a obrazy pomijane. Tekst wpisu i kotwica są tworzone na podstawie tego zwykłego tekstu.
Które poziomy nagłówków są uwzględniane?
Domyślnie poziomy 2 i 3, ponieważ nagłówek poziomu 1 jest zwykle tytułem dokumentu. Ustaw najniższy i najwyższy poziom w zakresie od 1 do 6. Lista jest wcięta względem najwyższego znalezionego poziomu.
Czy mogę uzyskać numerowaną listę lub zwykły tekst?
Tak. Wybierz listę numerowaną, aby uzyskać 1., 2. i zagnieżdżone numerowanie, albo wyłącz linki, aby otrzymać same teksty nagłówków, na przykład do wydrukowanego konspektu.