Ключевые факты
- Категория
- Преобразование и кодирование
- Типы входных данных
- textarea, select, checkbox
- Тип результата
- text
- Покрытие примерами
- 4
- API доступен
- Yes
Обзор
Этот онлайн-инструмент автоматически создает структурированное оглавление (TOC) из ваших документов Markdown. Он сканирует заголовки от H1 до H6, генерирует совместимые с GitHub ссылки-якоря и позволяет настраивать уровни вложенности, стиль списков и формат вывода.
Когда использовать
- •При оформлении длинных файлов README.md для репозиториев на GitHub или GitLab.
- •При написании технической документации, руководств пользователя или книг в формате Markdown.
- •При подготовке статей для блогов и платформ, поддерживающих разметку Markdown и требующих удобной навигации.
Как это работает
- •Вставьте исходный текст Markdown в поле ввода.
- •Настройте параметры генерации: выберите диапазон уровней заголовков (от H1 до H6), стиль списка и тип отступов.
- •Укажите формат вывода (Markdown, HTML или оба варианта) и включите или отключите ссылки-якоря.
- •Скопируйте сгенерированное оглавление и вставьте его в свой документ.
Сценарии использования
Примеры
1. Оглавление для README проекта на GitHub
Frontend-разработчик- Контекст
- Разработчик подготовил подробное описание библиотеки в файле README.md с множеством разделов от H1 до H3.
- Проблема
- Пользователям сложно ориентироваться в длинном документе без кликабельного меню.
- Как использовать
- Вставить текст README в поле ввода, установить минимальный уровень H2, максимальный H3, включить ссылки-якоря и выбрать маркированный список.
- Пример конфигурации
-
minLevel: 2, maxLevel: 3, listStyle: unordered, includeAnchor: true, outputFormat: markdown - Результат
- Получено аккуратное оглавление со ссылками на разделы H2 и H3, готовое для вставки в начало README.md.
2. Навигация для технического руководства в формате HTML
Технический писатель- Контекст
- Писатель готовит справочное руководство и хочет встроить оглавление непосредственно в веб-страницу.
- Проблема
- Нужно преобразовать заголовки Markdown в HTML-список со ссылками-якорями.
- Как использовать
- Вставить Markdown-документ, выбрать формат вывода HTML, установить отступы в 4 пробела.
- Пример конфигурации
-
outputFormat: html, indent: 4spaces, includeAnchor: true - Результат
- Сгенерирован чистый HTML-код списка ul и li с якорными ссылками для интеграции в веб-шаблон.
Проверить на примерах
markdown, barcodeСвязанные хабы
FAQ
Как генерируются ссылки-якоря?
Ссылки создаются автоматически на основе текста заголовков в стиле GitHub: символы переводятся в нижний регистр, пробелы заменяются дефисами, а знаки пунктуации удаляются.
Можно ли ограничить уровни заголовков в оглавлении?
Да, вы можете задать минимальный и максимальный уровни заголовков (например, от H2 до H4) в настройках инструмента.
Какие стили списков поддерживаются?
Вы можете выбрать маркированный список (с дефисами) или нумерованный список.
Поддерживает ли генератор вывод в формате HTML?
Да, инструмент позволяет экспортировать оглавление в формате Markdown, HTML или в обоих форматах одновременно.
Зачем нужна опция «Обернуть в блок кода»?
Она помещает сгенерированное оглавление в блок кода Markdown, чтобы его было удобно скопировать без автоматического рендеринга в редакторе.