Markdown TOC Generator
Generate table of contents links from markdown headings
Input Markdown
Generated TOC
Czym jest Generator TOC Markdown?
Budujesz dokumentację lub długie README, które staje się trudne w nawigacji? Spis treści (TOC) ułatwia czytelnikom przechodzenie do interesujących ich sekcji. To narzędzie skanuje plik Markdown, znajduje wszystkie nagłówki (od H1 do H6), generuje odpowiednie linki zakotwiczające i tworzy strukturalny TOC do wklejenia na początku dokumentu.
Generator używa formatu kotwicy zgodnego z GitHub, więc TOC działa doskonale na GitHub, GitLab i innych platformach renderujących Markdown. Inteligentnie obsługuje poziomy nagłówków — możesz kontrolować głębokość TOC (pokazywać tylko H2-H3 lub włączyć wszystkie poziomy do H6), i automatycznie generuje prawidłowe wcięcia i zagnieżdżanie.
Twój TOC jest zawsze zsynchronizowany z nagłówkami — koniec z uszkodzonymi linkami zakotwiczającymi lub nieaktualnymi odniesieniami do sekcji. Znaki specjalne w nagłówkach są poprawnie obsługiwane, a wyjście jest gotowe do natychmiastowego wklejenia. Wszystko dzieje się w przeglądarce, natychmiast.
Jak używać Generatora TOC Markdown
Wykonaj te kroki, aby wygenerować spis treści z nagłówków Markdown.
Wklej, prześlij lub załaduj przykład
Wklej Markdown do lewego panelu Wejściowy Markdown lub kliknij Prześlij, aby załadować plik .md. Kliknij Przykład dla przykładowej dokumentacji. Narzędzie skanuje nagłówki (od # do ######).
Skonfiguruj poziomy Min/Max
Użyj menu rozwijanych Min H i Max H, aby kontrolować, które poziomy nagłówków pojawiają się w TOC. Wyjście aktualizuje się natychmiast. Linki zakotwiczające zgodne z GitHub.
Kopiuj lub pobierz
Kliknij Kopiuj lub Pobierz, aby użyć wyjścia. Wklej na początku dokumentu. Użyj Wyczyść, aby zacząć od nowa. Całe przetwarzanie odbywa się w przeglądarce.
Kiedy naprawdę by się przydało
Pliki README na GitHub
Budujesz kompleksowe README dla swojego projektu? TOC pomaga użytkownikom szybko znaleźć sekcje konfiguracji, ustawień, dokumentacji API i wkładu. GitHub automatycznie renderuje TOC z działającymi linkami zakotwiczającymi.
Strony dokumentacji
Duże projekty dokumentacji z 20+ stronami potrzebują struktury. Generuj TOC dla każdej strony i buduj główny TOC dla całej witryny. Czytelnicy pewnie nawigują po dokumentacji z przejrzystą strukturą.
Strony Wiki
Budujesz firmowe wiki lub bazy wiedzy z długimi artykułami? TOC na początku każdej strony poprawia użyteczność. Działa na GitHub Wiki, GitLab Wiki i innych wiki opartych na Markdown.
Długie treści
Wpisy na blogu, tutoriale, przewodniki lub dowolny długi dokument Markdown korzysta z TOC. Czytelnicy szybko przeglądający mogą przejść bezpośrednio do odpowiednich sekcji. Szczególnie przydatne dla technicznych tutoriali z wieloma krokami i sekcjami.
Często zadawane pytania
Czy muszę ręcznie tworzyć linki zakotwiczające?
Nie. Narzędzie generuje je automatycznie. GitHub, GitLab i większość platform kompatybilnych z CommonMark automatycznie tworzy kotwice z nagłówków, więc wygenerowane linki TOC działają od razu bez dodatkowej pracy.
Czy format kotwicy działa na wszystkich platformach?
Generator używa formatu kotwicy zgodnego z GitHub, który jest najszerzej obsługiwanym formatem. GitHub, GitLab i większość innych platform Markdown obsługuje ten format natywnie.
Jak są obsługiwane znaki specjalne w nagłówkach?
Generator automatycznie konwertuje znaki specjalne do formatów bezpiecznych dla kotwic. Spacje stają się myślnikami, wielkie litery stają się małymi, a specjalna interpunkcja jest konwertowana lub usuwana. Wynikowe kotwice są zawsze prawidłowe.
Czy mogę dostosować głębokość TOC?
Oczywiście. Menu rozwijane "Min H" kontroluje minimalny poziom nagłówka (H1, H2, itp.), a "Max H" kontroluje maksimum. Chcesz tylko H2-H3? Ustaw Min na H2 i Max na H3. Potrzebujesz pełnego TOC? Włącz wszystkie poziomy od H1 do H6.
Co jeśli moje nagłówki zawierają cyfry lub symbole?
Są obsługiwane poprawnie. Nagłówek jak "Krok 1: Pierwsze kroki" jest konwertowany na kotwicę jak #krok-1-pierwsze-kroki. Znaki specjalne są przetwarzane zgodnie ze standardowymi regułami kotwic Markdown.
Czy moja zawartość Markdown jest przechowywana?
Nie. Całe generowanie TOC odbywa się w przeglądarce za pomocą JavaScript. Twój Markdown nigdy nie opuszcza komputera. Pełna prywatność i bezpieczeństwo.