Spis treści dla pliku Markdown, w pięć sekund
Długie pliki dokumentacji (README na 800 linii, plik changelog, instrukcja deployu) trudno czyta się bez spisu treści na górze. Czytelnik chce dojść do "Troubleshooting" albo "API reference" w jednym kliknięciu, a nie skrolować dziesięć ekranów.
To narzędzie czyta Twój Markdown, wyłapuje wszystkie nagłówki (H1 do H6) i składa z nich zagnieżdżoną listę punktowaną z linkami do anchor. Linki działają od razu na GitHubie, GitLabie, w Docusaurusie, Astro i większości generatorów stron statycznych.
Pomijamy nagłówki wewnątrz bloków kodu (`# nie jest H1, jeśli jest w \`\`\`bash`). Generator ma trzy style anchora (GitHub, GitLab, zwykły), tryb wstawiania spisu prosto do dokumentu, znaczniki `<!-- TOC -->` dla narzędzi auto-aktualizujących i przełącznik "pomiń pierwszy H1".
Jak używać
- Wklej swój Markdown w lewe pole. Domyślnie ładuje się przykład z kilkoma nagłówkami, żeby narzędzie miało co pokazać.
- Ustaw zakres głębokości suwakami, domyślnie H1 do H4. Jeśli nie chcesz w spisie najmniejszych nagłówków, ustaw maks na H3. Jeśli interesują Cię tylko sekcje główne, ustaw maks na H2.
- Wybierz styl anchora: GitHub (najczęściej używany, działa też na GitLab i Docusaurus), GitLab (drobne różnice w cyfrach na początku), Zwykły (klasyczny slugify, bez polskich znaków).
- Włącz "Lista numerowana", jeśli wolisz `1.` zamiast `-`. Numery same się dopasowują przy renderowaniu (GitHub pokazuje 1, 2, 3 nawet, jak wszystkie wpisy mają `1.`).
- "Pomiń pierwszy H1", jeśli pierwsza linia pliku to tytuł całego dokumentu (np. nazwa projektu w README), zwykle nie chcesz go w spisie. Włącz przełącznik.
- "Tryb wstawiania", zamiast tylko spisu, generator zwraca cały dokument z wklejonym spisem treści zaraz po pierwszym H1. Wygodne, jak masz duży istniejący plik i chcesz dodać TOC bez ręcznej edycji.
- Skopiuj spis (albo cały dokument w trybie wstawiania) i wklej do swojego pliku. Albo pobierz jako plik .md.
Do czego się przydaje
Konkretne sytuacje, w których spis treści jest niezbędny:
- Duże README projektu open-source. Plik ma 12 sekcji, "Installation", "Quick start", "Configuration", "API", "Examples", "Troubleshooting", "Contributing", "License". Bez spisu treści użytkownik musi zjeżdżać. Ze spisem klika i jest na miejscu.
- Plik CHANGELOG.md z kilkudziesięcioma wersjami. Spis treści linkujący do każdej wersji (`## v1.4.2, 2025-10-12`, `## v1.4.1, 2025-10-08`, ...) pozwala dojść do interesującego release w mig. Wygeneruj spis raz, dopisuj nowe wersje na górze, spis musi być aktualizowany ręcznie albo automatycznie przez narzędzie typu `markdown-toc`.
- Dokumentacja techniczna w Docusaurusie / Astro / MkDocs. Niektóre szablony same generują spis treści w sidebarze, ale wewnątrz strony też warto mieć spis dla długich artykułów. Tu generujesz go raz, wklejasz w plik, działa.
- Migracja dokumentacji z Confluence/Notion. Eksport z tych narzędzi nie zawsze ma porządny spis treści. Wklejasz, generujesz, wklejasz spis na górze.
- Książka albo dłuższy artykuł pisany w Markdown. Książki techniczne często pisze się w Markdownie (przykład: Pragmatic Bookshelf, Manning). Każdy rozdział potrzebuje spisu sekcji.
- Wewnętrzna dokumentacja firmy. README repo z infrastrukturą, runbook do incidentów, onboarding doc dla nowych pracowników, wszystko, co ma więcej niż 5 sekcji.
Jeśli budujesz README od zera, użyj naszego generatora README, on dokleja spis treści automatycznie. Jeśli sprzątasz po sobie, sprawdź dokument linterem Markdown, łapie typowe błędy z anchor linkami.