Table of Contents Generator
Automatically extract headings from Markdown and generate a linked TOC.
O tym narzędziu
Generuje Spis treści z nagłówków Markdown (od # do ######). Wklej dokument Markdown i wybierz między zwykłymi linkami Markdown, numerowanym Markdown lub blokiem HTML nav.
Poziomy nagłówków można filtrować za pomocą elementów sterujących Min/Maks, aby uwzględnić tylko wymagane głębokości.
Jak używać
- Wklej dokument Markdown w polu wejściowym.
- Wybierz format wyjściowy: Markdown, Numerowany Markdown lub HTML.
- Ustaw minimalne i maksymalne poziomy nagłówków, aby filtrować głębokość.
- Skopiuj wygenerowany Spis treści i wklej go do dokumentu.
Przypadki użycia
Autorzy dokumentacji dodają spis treści na początku plików README lub stron wiki. Pisarze techniczni wstawiają sekcję nawigacyjną przed długimi artykułami. Programiści generują bloki HTML nav dla generatorów stron statycznych.
Często zadawane pytania
- Jakie poziomy nagłówków są obsługiwane? — H1 do H6 (od # do ######). Użyj elementów sterujących Min/Maks, aby ograniczyć poziomy wyświetlane w spisie treści.
- Czy obsługuje nagłówki nie-łacińskie? — Tak. Tekst nagłówka jest zachowany w niezmienionej postaci w etykietach linków. Slug kotwicy jest generowany przez zmianę na małe litery i usunięcie znaków niebędących słowami, zgodnie z zachowaniem GitHub Markdown.
- Czy mogę użyć wyjścia HTML bezpośrednio na stronie internetowej? — Tak. Wyjście HTML generuje strukturę <nav><ul><li><a href="#..."> kompatybilną ze standardowymi linkami kotwic.