Содержание Markdown

Автоматическое добавление содержания со ссылками в файлы Markdown

Длинные файлы README и внутренние вики сталкиваются с одной и той же проблемой: читатель прокручивает всю страницу, прежде чем найти нужный раздел. Если Вы хоть раз открывали длинный файл Markdown и хотели, чтобы он начинался с кликабельного плана, инструмент Содержание Markdown создаёт такой план за Вас.

Вы передаёте инструменту один файл Markdown, а он считывает каждый заголовок, превращает его в ссылку и вставляет этот список рядом с началом документа в виде нового файла, который можно скачать. Опция «Включать заголовки до уровня» позволяет выбрать 2, 3 или 4; значение по умолчанию (3) обычно охватывает основные разделы и их подразделы, не затрагивая при этом каждый мелкий заголовок. Ссылки следуют стандартному стилю якорей Markdown, поэтому работают одинаково как в репозитории кода, так и на статическом сайте.

Обработка происходит на серверах самого сайта по защищённому соединению, а файл удаляется в течение шестидесяти минут, так что после завершения ничего не остаётся. Инструмент только строит план; он не перенумеровывает Ваши заголовки и не исправляет те, что пропускают уровень, поэтому неровная структура заголовков даёт неровное содержание. Сначала выровняйте заголовки, если результат выглядит неправильно, затем запустите инструмент снова.

Использование бесплатно в рамках суточного лимита, а бесплатная учётная запись снимает это ограничение. Инструмент работает из браузера на компьютере или телефоне, ничего устанавливать не нужно.