~/tools/markdown/toc-generator
MarkdownMarkdown TOC Generator
Сгенерировать оглавление по заголовкам Markdown-документа.
Как это работает
Длинный README или статья в Markdown без оглавления заставляет читателя листать вслепую в поисках нужного раздела. Markdown toc generator online собирает оглавление по всем заголовкам документа автоматически, с правильными ссылками якорями, которые ведут прямо на нужный раздел при клике.
Инструмент проходит по всем строкам, начинающимся с решетки, определяет уровень заголовка по количеству решеток и генерирует вложенный список ссылок с отступом, соответствующим глубине заголовка. Ссылка генерируется по тем же правилам транслитерации якорей, что использует GitHub и большинство других Markdown рендереров.
Полученное оглавление достаточно вставить в начало документа один раз, а дальше README или статья становится удобной для навигации даже при паре десятков разделов внутри одного длинного файла.
Частые вопросы
Работают ли сгенерированные ссылки якоря на GitHub?
Да, генерация ссылок ориентирована на правила, которые использует GitHub при автоматическом создании якорей из текста заголовков, но в других системах рендеринга markdown правила транслитерации якорей могут немного отличаться.
Что происходит с заголовками, где есть специальные символы или знаки препинания?
Специальные символы и знаки препинания убираются при генерации якоря, остаются только буквы, цифры и дефисы вместо пробелов, ровно как это делает большинство систем рендеринга markdown.
Обновляется ли оглавление автоматически при изменении документа?
Нет, это разовая генерация по текущему состоянию текста, при добавлении новых заголовков оглавление нужно будет перегенерировать заново через этот же инструмент.
Учитываются ли заголовки внутри блоков кода?
Строки внутри блока кода, начинающиеся с решетки, например комментарии в Python, могут быть ошибочно распознаны как markdown заголовки, если блок кода не оформлен тройными обратными кавычками, стоит проверить результат вручную в таком случае.