Генератор оглавления Markdown
Создание оглавления Markdown в стиле GitHub на основе заголовков в вашем документе.
Keep your original file until you have checked the downloaded result. Browser memory and format support vary by device.
Headings inside fenced code blocks are ignored. The generated anchors follow GitHub-style slug rules.
Генератор оглавления Markdown
Создание оглавления Markdown из заголовков документа. Вставьте текст или откройте файл, выберите, включать ли заголовок H1, и создайте отдельный список якорных ссылок. Это узкоспециализированный генератор структуры для файлов README, технической документации, заметок и контента статических сайтов.
В этом руководстве описан полный рабочий процесс в браузере, состав результата и проверки перед публикацией. Инструмент намеренно сфокусирован на одной чёткой задаче. Он не добавляет незаметно постороннее редактирование, конвертацию, загрузку или функции облачного хранения. Такая узкая спецификация делает входные и выходные данные проще для понимания и даёт вам практический способ проверить загруженный файл.
Как использовать
Начните с копии файла, который нужно обработать. На странице может потребоваться загрузка браузерной библиотеки перед доступностью действия, особенно для задач с PDF или видео. Выполните следующие шаги:
- Вставьте Markdown в редактор ввода или нажмите Открыть, чтобы загрузить файл .md или .markdown.
- Проверьте исходные заголовки и убедитесь, что используется стандартный ATX-синтаксис, например ## Раздел.
- Включите параметр Include the H1 heading, если заголовок документа должен отображаться в списке.
- Нажмите Generate Table of Contents и проверьте ссылки на панели вывода.
- Вставьте результат в свой документ или скачайте его как отдельный Markdown-файл.
При работе с важным или необычно сложным документом сначала используйте небольшой репрезентативный файл. Дождитесь сообщения о завершении обработки, прежде чем закрывать вкладку. Если браузер сообщает об ошибке декодирования, памяти или совместимости, попробуйте более маленький файл или более распространённый исходный формат. Исходный файл не заменяется при загрузке результата, поэтому храните его до проверки.
Подходящие задачи
Инструмент полезен для сосредоточенных, повторяемых задач подготовки файлов, таких как:
- Создание навигационного списка для README на GitHub или страницы документации проекта.
- Быстрое построение структуры из протоколов совещаний, учебных раздаточных материалов или длинного технического руководства.
- Обновление оглавления после добавления или изменения порядка заголовков.
- Подготовка Markdown-контента для генератора статических сайтов или базы знаний.
Он не заменяет полнофункциональный настольный редактор, когда нужна многодорожечная временная шкала, продвинутая типографика, сложные PDF-формы, профессиональное управление цветом, гарантииforensic-метаданных или точное сохранение всех функций проприетарных файлов. Используйте задачу, соответствующую вашей цели, и сравнивайте загруженный файл с исходным перед использованием.
Формат вывода
Результат — UTF-8 Markdown с одной маркированной ссылкой для каждого обнаруженного заголовка. Заголовки ATX от H1 до H6 распознаются вне огороженных кодовых блоков. Отступы отражают глубину заголовка относительно первого найденного заголовка, а повторяющийся текст заголовка получает числовый суффикс, чтобы ссылки оставались уникальными. Правила генерации якорей немного различаются в GitHub, GitLab, библиотеках Markdown и генераторах статических сайтов, поэтому проверяйте готовый документ в платформе, где он будет опубликован. Исходный Markdown не переписывается.
Загрузка создаёт новый файл или пакет; выбранный во входовой панели файл не изменяется. Имена файлов генерируются на основе исходного имени, где это возможно, с целевым суффиксом, чтобы исходный файл и результат было легко различать. Результат в ZIP может содержать несколько сгенерированных активов и должен быть открыт для подтверждения наличия ожидаемых файлов. Для текстовых результатов после загрузки проверьте переводы строк, кодировку, отступы и любую специфичную для платформы синтаксическую разметку. Для визуальных или документных результатов проверьте размеры, порядок страниц, воспроизведение, шрифты, ссылки, прозрачность и другие особенности, важные для целевого приложения.
Конфиденциальность
Текст обрабатывается в браузере и не отправляется в AI-сервисы написания текста или удалённые Markdown-API в рамках этого рабочего процесса. Выбранный файл может оставаться в памяти страницы до закрытия вкладки. Избегайте вставки конфиденциальных учётных данных, приватной клиентской информации, непроверенных юридических материалов или другого чувствительного текста на общественных устройствах. Уровень конфиденциальности вывода определяется только устройством и сеансом браузера, использованными для его создания.
Обработка в браузере не гарантирует, что все окружающие веб-сайты, расширения браузера, операционная система или общественные компьютеры обеспечивают приватность. Используйте доверенное устройство, закрывайте вкладку после работы с конфиденциальными материалами и избегайте общественных компьютеров. Не выбирайте файлы, которыми вы не владеете или на редактирование которых нет разрешения. Если ваша организация требует оформленного соглашения об обработке данных, политики хранения или журнала аудита, используйте утверждённый внутренний рабочий процесс вместо полагания только на публичный браузерный инструмент.
Примечания по качеству и совместимости
Генератор намеренно использует консервативное обнаружение заголовков. Он не рендерит все расширения Markdown, не выводит заголовки из жирного начертания, не проверяет HTML-элементы заголовков и не гарантирует, что пользовательские правила слагирования совпадают с вашей платформой публикации. Заголовки внутри огороженных кодовых блоков игнорируются, но необычная вложенность огораживаний или сгенерированный HTML могут потребовать ручной проверки. Проверяйте пунктуацию, повторяющиеся заголовки и цели ссылок перед публикацией.
Успешная загрузка означает только, что браузер создал результат; это не гарантия, что каждое целевое приложение примет или отобразит его в точности. Откройте результат в приложении, веб-сайте или устройстве, где он будет использоваться. Когда важна точность, сравнивайте исходный текст и вывод рядом и храните исходный файл как восстанавливаемый мастер.
FAQ: Генератор оглавления Markdown
Включаются ли заголовки внутри кодовых блоков?
Нет. Огороженные кодовые блоки игнорируются, чтобы пример заголовков в коде не путали с разделами документа.
Поддерживаются ли уровни H1–H6?
Да. Стандартные ATX-заголовки от одного до шести знаков решётки распознаются, когда после маркера следует пробел.
Можно включить заголовок документа?
Да. Включите Include the H1 heading перед созданием оглавления.
Будут ли ссылки работать на каждом Markdown-сайте?
Это ссылки в стиле GitHub, но поведение slug может отличаться. Проверяйте результат в целевом рендерере, особенно если заголовки содержат пунктуацию или не латинский текст.
Изменяет ли инструмент исходный Markdown?
Нет. Создаётся отдельный результат оглавления, а исходный текст остаётся доступным для вашего редактирования.