Generator spisu treści Markdown
Wklej Markdown lub upuść plik .md, aby otrzymać zagnieżdżony spis treści z kotwicami zgodnymi z GitHubem — gotowy do skopiowania z powrotem.
Twój plik nigdy nie opuszcza urządzenia.
Upuść tutaj plik .md lub
Wklej lub prześlij Markdown, aby wygenerować spis treści.
Nie znaleziono nagłówków
Ten dokument nie ma nagłówków poza blokami kodu, więc nie ma do czego linkować.
Spis treści
O generatorze spisu treści Markdown
Kotwice zgodne z GitHubem
Kotwice trzymają się własnej reguły slugów GitHuba: tekst nagłówka jest zamieniany na małe litery, interpunkcja usuwana, a każda pozostała spacja staje się myślnikiem. Oznacza to, że linki generowane przez to narzędzie działają, gdy wkleisz spis treści do README na GitHubie albo GitLabie — łącznie ze szczegółami, które łatwo pomylić, jak interpunkcja między dwoma słowami zostawiająca po sobie podwójny myślnik. Powtórzone nagłówki dostają od GitHuba przyrostki -1, -2 w kolejności dokumentu, więc dwie sekcje o tej samej nazwie „Przegląd” linkują we właściwe miejsca.
Znajduje oba style nagłówków
Zbierane są zarówno nagłówki ATX (## Nagłówek), jak i setext (tekst podkreślony === albo ---). Setext łatwo przeoczyć — podkreślenie myślnikami jest nie do odróżnienia od linii poziomej, jeśli nie spojrzy się na wiersz powyżej — więc sprawdzenie jest wspólne z naszym formaterem i walidatorem, co gwarantuje, że wszystkie trzy się zgadzają. Nagłówki wewnątrz ogrodzonych i wciętych bloków kodu są ignorowane, podobnie jak wszystko, co znajduje się w front matter YAML.
Zagnieżdżenie idzie za Twoim dokumentem
Wcięcie jest mierzone od najpłytszego nagłówka faktycznie obecnego w dokumencie, więc dokument, którego sekcje zaczynają się od ##, daje płaską listę najwyższego poziomu, a nie bezsensownie wciętą. Głębsze nagłówki zagnieżdżają się pod nimi. Wszystko dzieje się lokalnie w Twojej przeglądarce — dokument jest czytany na Twoim urządzeniu i nic nie jest przesyłane ani przechowywane.
Generuj bez przesyłania — Twój plik nigdy nie opuszcza Twojego urządzenia
To narzędzie działa w całości w Twojej przeglądarce, w JavaScripcie. Twój Markdown nigdy nie jest przesyłany na serwer, nigdy przechowywany i nigdy nie opuszcza Twojego urządzenia — dzięki temu szkice, notatki i dokumenty pozostają prywatne.
Najczęstsze pytania
- Czy linki zadziałają na GitHubie?
- Tak — kotwice są generowane regułą slugów GitHuba, więc wklejenie spisu treści do README daje działające linki. Łącznie z dokładnym odwzorowaniem dziwactw GitHuba: nagłówek w rodzaju „Konfiguracja — część pierwsza” daje podwójny myślnik w miejscu pauzy, bo dokładnie to generuje GitHub.
- Czy znajduje podkreślane nagłówki (setext)?
- Tak. Zbierane są zarówno nagłówki z #, jak i podkreślone === albo ---. To samo sprawdzenie podkreślenie-kontra-linia-pozioma jest wspólne z Formatuj Markdown i Sprawdź Markdown, więc wszystkie trzy narzędzia zgadzają się co do tego, co liczy się jako nagłówek.
- A co z powtórzonymi nagłówkami?
- Dostają liczbowe przyrostki GitHuba w kolejności dokumentu — pierwszy „Przegląd” linkuje do #przegląd, drugi do #przegląd-1 — dokładnie tak, jak rozwiązuje je renderer.
- Czy jest pobieranie?
- Nie — spis treści to fragment, który wklejasz z powrotem do swojego dokumentu, a nie plik do przechowywania. Jest przycisk kopiowania; pole wyniku można też po prostu zaznaczyć, jeśli wolisz.
- Czy nagłówki wewnątrz bloków kodu są uwzględniane?
- Nie. Ogrodzone i wcięte bloki kodu są pomijane, więc wiersz z # wewnątrz przykładu nigdy nie zostanie wzięty za nagłówek. Front matter YAML też jest pomijany.
- Czy to przesyła mój plik?
- Nie. Generowanie odbywa się w całości w Twojej przeglądarce, w JavaScripcie — Twój Markdown nigdy nie jest wysyłany na serwer i nigdy nie opuszcza Twojego urządzenia.
Wkrótce więcej narzędzi Markdown
Markdown na PDF, łączenie, dzielenie i więcej — za darmo i w przeglądarce.
Powrót do wszystkich narzędzi →