Входных данных пока нет.
Оглавление с якорями GitHub
Этот генератор оглавления Markdown собирает содержание файла из его заголовков с якорными ссылками, совместимыми с GitHub и GitLab. Вставьте README и скопируйте оглавление или скачайте документ, в котором оно уже стоит между маркерами.
Обновлено:
Как это работает
Вставьте Markdown
Вставьте README, откройте файл .md или нажмите «Открыть по ссылке». Заголовки внутри блоков кода и HTML-комментариев не учитываются.
Выберите уровни и стиль
Укажите, какие уровни заголовков включать, маркеры или номера, отступ и якоря GitHub или GitLab.
Скопируйте или вставьте в документ
Скопируйте только список или возьмите весь документ: оглавление встает между маркерами <!-- toc -->, а существующий блок оглавления заменяется.
Возможности
Якоря точно как на GitHub
Якоря строятся по правилам github-slugger: нижний регистр, без знаков препинания, пробелы — дефисы, а повторяющиеся заголовки нумеруются -1, -2 по всей странице.
Безопасный повторный запуск
Распознаются маркеры markdown-toc (<!-- toc -->), Markdown All in One (<!-- TOC -->) и doctoc, поэтому при обновлении оглавление не дублируется.
Чистый текст ссылок
Жирный текст, курсив, встроенный код и ссылки в заголовках сводятся к видимому тексту — так, как заголовок выглядит после отрисовки.
Заголовки Setext тоже
Находятся не только заголовки с #, но и подчеркнутые строками === или ---.
Проверка каждого якоря
Вкладка «Якоря» показывает каждый заголовок с уровнем и созданным #якорем — удобно, когда нужно сослаться на раздел с другой страницы.
Ограничения и конфиденциальность
Документы до 5 MB; более крупные обрабатываются в фоновом потоке, чтобы ввод не тормозил. Оглавление создается в браузере, а файл на сервер не загружается. Подробнее — на странице о конфиденциальности.
Частые вопросы
Как добавить оглавление в README на GitHub?
Вставьте README, оставьте якоря GitHub и уровни H2–H3 и скачайте документ. Оглавление окажется под заголовком между маркерами <!-- toc -->.
Почему не работают ссылки на якоря?
Якоря зависят от платформы: GitHub удаляет знаки препинания и сохраняет двойные дефисы, а GitLab их схлопывает. Выберите ту платформу, где будет показан файл.
Работают ли якоря с русскими заголовками?
Да. Кириллица остается в якоре в нижнем регистре, пробелы заменяются дефисами: заголовок Быстрый старт получает якорь #быстрый-старт — так же, как на GitHub.
Как обрабатываются одинаковые заголовки?
Как на GitHub: второй заголовок Установка получает якорь #установка-1, третий — #установка-2. Скрытые и пропущенные заголовки тоже учитываются.
Можно ли обновить существующее оглавление?
Да. Если в документе уже есть оглавление между известными маркерами, заменяется только этот блок, а остальной файл остается байт в байт прежним.
Можно ли сделать нумерованное оглавление?
Выберите в поле «Вид списка» вариант с номером 1. Каждый уровень нумеруется отдельно и получает отступ под текстом родительского пункта.
Нужен ли заголовок документа в оглавлении?
Обычно нет. Параметр «Пропустить заголовок документа (первый H1)» убирает первый H1, и список начинается сразу с разделов.