Перейти к содержанию
TextArray
100% локально

Генератор оглавления Markdown

Создайте связанное оглавление из заголовков документа Markdown с помощью привязок в стиле GitHub.

Входные данные
Выходные данные

Генератор оглавления Markdown

Вставьте документ Markdown и мгновенно получите связанное оглавление. Инструмент сканирует текст на наличие заголовков ATX — от # до ###### — и создает вложенный список Markdown, готовый для вставки в верхнюю часть README, вики-страницы или любого файла документации. Строки, подобные заголовкам, внутри изолированных блоков кода игнорируются, поэтому пример Markdown в ваших фрагментах никогда не пропускает фантомную запись в оглавление.

Якоря следуют правилам GitHub: текст заголовка пишется строчными буквами, пробелы становятся дефисами, знаки препинания удаляются, а буквы с диакритическими знаками сохраняются — GitHub их тоже сохраняет, поэтому заголовок типа «Číslo účtu» ссылается как #číslo-účtu, а TOC работает на github.com, GitLab и большинстве средств визуализации Markdown «из коробки». Когда несколько заголовков имеют один и тот же текст, второй и третий получают суффиксы -1 и -2, точно так, как их нумерует GitHub. Из метки исчезнет жирный, курсив, встроенный код и разметка ссылок внутри заголовка; его читаемый текст остается.

Выбор «Уровни» контролирует глубину списка: H2–H3 по умолчанию подходит для большинства файлов README, H1–H6 охватывает все, а только H2 или H2–H4 подходят для более плоских или глубоких документов. Стиль переключается между маркерами и нумерованным списком, снятие флажка «Ссылки» создает контур в виде обычного текста вместо якорных ссылок, а «Отступ с табуляциями» заменяет вложение двух пробелов для символов табуляции в соответствии с тем стилем, который использует ваш репозиторий.

Все работает локально в вашем браузере — документ никогда не загружается, поэтому частные спецификации и невыпущенные черновики остаются на вашем устройстве. Подсчет результатов подсчитывает найденные заголовки и созданные строки оглавления, а результат можно скопировать или загрузить одним щелчком мыши.

FAQ

Какие заголовки распознает инструмент?
Заголовки ATX — строка, начинающаяся с 1–6 символов решетки и пробела, от # до ######. Заголовки внутри ``` изолированных блоков кода пропускаются. Заголовки Settext (строка, подчеркнутая знаком === или ---) не распознаются; вместо этого напишите их как # заголовки.
Будут ли ссылки работать на GitHub?
Да. Якоря создаются по правилам GitHub — строчные буквы, пробелы вместо дефисов, пунктуация удалена, диакритические знаки сохранены — а повторяющиеся заголовки получают те же суффиксы -1, -2, которые добавляет GitHub, поэтому оглавление работает при вставке в README.
Могу ли я вместо этого получить нумерованный список или обычный текст?
Да. Установите для стиля значение «Нумерованный», чтобы получить упорядоченный список со счетчиками на каждом уровне, и снимите флажок «Ссылки», чтобы получить простой контур без привязочных ссылок. Отступ с табуляцией заменяет вложение табуляции в два пробела.
Мой документ загружен куда-нибудь?
Нет. Инструмент полностью работает в вашем браузере, и ваш текст никогда не покидает ваше устройство.