Generator TOC Markdown
Automatycznie generuj spis treści z linkami z nagłówków Markdown — idealny do READMEs, dokumentacji i długich stron wiki.
Wejście Markdown
Wygenerowany TOC
Przykłady TOC Markdown
Generuj linki kotwic z nagłówków. Przykład:
Nagłówki podręcznika projektu
Wejście Markdown:
Wygenerowany TOC:
Użyj Przykład powyżej, aby załadować więcej nagłówków.
Czym jest Generator TOC Markdown?
Spis treści (TOC) pomaga czytelnikom nawigować po długich dokumentach. W Markdown nagłówki używają od # do ######. Generator TOC skanuje nagłówki i tworzy listę linków prowadzących do każdej sekcji. GitHub Flavored Markdown i wiele generatorów stron statycznych obsługuje linki kotwic generowane z tekstu nagłówka.
To narzędzie działa w przeglądarce. Wklej Markdown lub wczytaj plik; TOC aktualizuje się podczas edycji. Możesz ustawić minimalne i maksymalne poziomy nagłówków (np. tylko H2–H4). Slagi kotwic są tworzone z tekstu nagłówka i deduplikowane dla powtarzających się nagłówków. Do formatowania Markdown użyj Formatera Markdown. Do konwersji na HTML użyj Markdown do HTML.
Jak używać tego narzędzia
Wklej lub wczytaj Markdown
Wklej Markdown do lewego edytora lub kliknij Wczytaj, aby załadować plik .md, .markdown lub .txt. Użyj Przykład, aby załadować przykładowe nagłówki. TOC aktualizuje się automatycznie.
Ustaw zakres poziomów nagłówków
Użyj Min H1–H4 i Max H3–H6, aby uwzględnić tylko wybrane poziomy nagłówków. Na przykład Min H2 i Max H4 pomija H1 i H5–H6. To pozwala skupić się na długich dokumentach.
Kopiuj lub pobierz TOC
Skopiuj wygenerowany TOC do schowka lub pobierz go. Wklej na początku swojego README lub dokumentu. Do lintowania Markdown użyj Lintera Markdown. Po pomoc ze składnią zajrzyj do Ściągawki Markdown.
Gdzie generowanie TOC jest przydatne
Pliki README na GitHub, strony dokumentacji i wiki korzystają z TOC. Czytelnicy mogą przeskakiwać do sekcji bez przewijania. Specyfikacja CommonMark definiuje składnię nagłówków; GFM i większość rendererów obsługuje linki #anchor-slug. Generatory statyczne jak Eleventy i VitePress często automatycznie generują kotwice.
Do tworzenia tabel z CSV lub danych rozdzielanych użyj Generatora Tabel Markdown. Po szybki podgląd składni zajrzyj do Ściągawki Markdown. Do konwersji Markdown na HTML użyj Markdown do HTML.
Często zadawane pytania
Jak są generowane linki kotwic?
Linki kotwic są generowane przez zamianę tekstu nagłówka na małe litery, zastąpienie spacji myślnikami i usunięcie znaków specjalnych — zgodnie z formatem kotwic GitHub Flavored Markdown. Na przykład "Pierwsze Kroki" staje się #pierwsze-kroki.
Czy linki TOC będą działać na GitHub?
Tak — format kotwic odpowiada konwencjom GitHub Flavored Markdown, więc linki TOC działają poprawnie w plikach README, wiki i opisach pull requestów GitHub.
Czy mogę wybrać, które poziomy nagłówków uwzględnić?
Tak — możesz skonfigurować minimalną i maksymalną głębokość nagłówków do uwzględnienia w TOC. Na przykład możesz chcieć uwzględnić tylko H2 i H3, pomijając tytuł H1 najwyższego poziomu.
Co się dzieje, gdy moje nagłówki mają znaki specjalne?
Znaki specjalne takie jak #, *, ? i znaki interpunkcyjne są usuwane z linków kotwic. Emoji są zwykle również usuwane. Narzędzie obsługuje to automatycznie, aby linki TOC pozostały prawidłowe.
Powiązane narzędzia
Dowiedz się więcej: CommonMark, specyfikacja CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.