Brak danych wejściowych.
Spis treści z kotwicami jak na GitHubie
Ten generator tworzy spis treści dla pliku Markdown na podstawie nagłówków, z linkami-kotwicami zgodnymi z GitHubem i GitLabem. Wystarczy wkleić README i skopiować spis albo pobrać dokument ze spisem wstawionym między znacznikami.
Ostatnia aktualizacja:
Jak to działa
Wklej Markdown
Wystarczy wkleić README, otworzyć plik .md lub wczytać go z adresu URL. Nagłówki w blokach kodu i komentarzach HTML są pomijane.
Wybierz poziomy i styl
Do ustalenia są poziomy nagłówków w spisie („Od” i „Do”), punktory lub numeracja, wcięcie oraz kotwice w stylu GitHuba lub GitLaba.
Skopiuj lub wstaw
Można skopiować samą listę albo wziąć cały dokument: spis trafia między znaczniki <!-- toc -->, a istniejący blok spisu treści zostaje zastąpiony.
Funkcje
Kotwice dokładnie jak na GitHubie
Kotwice powstają według github-slugger: małe litery, bez interpunkcji, spacje zamienione na łączniki, a powtórzone nagłówki numerowane -1, -2 w obrębie całej strony. Polskie litery w kotwicach zostają, tak jak na GitHubie.
Bezpieczne ponowne generowanie
Rozpoznawane są znaczniki markdown-toc (<!-- toc -->), Markdown All in One (<!-- TOC -->) i doctoc, więc aktualizacja nigdy nie dubluje spisu.
Czysty tekst linków
Pogrubienia, kursywa, kod i linki w nagłówkach są sprowadzane do widocznego tekstu – tak, jak czyta się wyrenderowany nagłówek.
Także nagłówki Setext
Znajdowane są zarówno nagłówki z #, jak i podkreślone znakami === lub ---.
Kontrola każdej kotwicy
Karta „Kotwice” pokazuje każdy nagłówek z poziomem i wygenerowaną #kotwicą – przydatne przy linkowaniu z innych stron.
Limity i prywatność
Dokumenty do 5 MB; większe są przetwarzane w wątku roboczym w tle, dzięki czemu pisanie pozostaje płynne. Spis treści powstaje w przeglądarce, a plik nigdy nie jest wysyłany na serwer. Więcej na stronie o prywatności.
Najczęstsze pytania
Jak dodać spis treści do README na GitHubie?
Wystarczy wkleić README, zostawić kotwice GitHuba i zakres H2–H3, a potem pobrać dokument. Spis treści pojawi się pod tytułem, między znacznikami <!-- toc -->.
Dlaczego linki-kotwice nie działają?
Kotwice zależą od platformy. GitHub usuwa interpunkcję i zostawia podwójne łączniki, GitLab je scala. Należy wybrać platformę, na której plik będzie wyświetlany.
Co z powtarzającymi się nagłówkami?
Tak jak na GitHubie: drugi nagłówek „Użycie” dostaje kotwicę #użycie-1, trzeci #użycie-2. Ukryte lub pominięte nagłówki też się liczą.
Czy można zaktualizować istniejący spis treści?
Tak. Jeśli dokument ma już spis między znanymi znacznikami, zastępowany jest tylko ten blok; reszta pliku pozostaje identyczna co do bajtu.
Jak zrobić numerowany spis treści?
Wystarczy wybrać styl listy „1.”. Każdy poziom jest numerowany osobno i wcięty pod tekstem elementu nadrzędnego.
Czy tytuł dokumentu powinien być w spisie?
Zwykle nie. Opcja „Pomiń tytuł (pierwszy H1)” pomija pierwszy nagłówek H1, więc lista zaczyna się od rozdziałów.