Command Palette

Search for a command to run...

ГЕ

Генератор TOC Markdown

Создайте связанное оглавление из заголовков Markdown

Что такое генератор таблицы содержания разметки?

Генератор оглавления Markdown считывает заголовки в документе Markdown и выдает вложенный список ссылок, которые переходят в каждый раздел. вы вставляете Markdown, и инструмент возвращает готовый к использованию блок, такой как запутанный список, где каждая строка является ссылкой `[Heading](#anchor)`.Это спасает вас от написания плана вручную и от угадывания идентификатора якоря, который рендерер назначит каждому заголовку.

Сердцем инструмента является якорь slug. GitHub, GitLab и большинство генераторов статических сайтов превращают заголовок, подобный "Getting Started", в id `getting-started`, опуская текст, удаляя пунктуацию и заменяя пробелы дефисами. Этот генератор применяет то же самое правило, включая числовой суффикс (`-1`, `-2`), который добавляет GitHub, когда два заголовка имеют общий slug, поэтому ссылки, которые он создает, разрешаются к точным идентификаторам, которые будет отображать ваша страница README или docs. Он читает как заголовки ATX (строки, начинающиеся с `#`), так и заголовки Setext (текст, подчеркнутый `=` или `-`), и игнорирует любой #`, который появляется внутри огороженного блока кода. Заголовки, несущие в линейном формате, обрабатываются одинаково: ссылка, жирный текст, встроенный код или изображение внутри заголовка сводится к простому тексту для этикетки, и якорь строится из этой же строки, поэтому всегда согласуйтесь.

Все работает в вашем браузере.Вставка Markdown анализируется с помощью JavaScript на стороне клиента и никогда не покидает ваше устройство, поэтому нет ни загрузки, ни учетной записи, ни отслеживания вашего контента. инструмент работает в автономном режиме после загрузки страницы, позволяет вам выбирать уровни заголовка для включения, переключаться между заполненными и пронумерованными списками и контролировать отступ, а также обновляет схему в момент изменения опции.

Как использовать генератор TOC Markdown?

  1. Вставьте свой уценка

    Бросьте свой полный документ Markdown или README во входное поле. Заголовки внутри огражденных блоков кода пропускаются автоматически.

  2. Выберите уровни заголовков

    Установите самые мелкие и глубокие уровни, чтобы включить. Распространенный выбор - от H2 до H3, который сохраняет контур читаемым без перечисления каждого подраздела.

  3. Выберите стиль списка

    Переключайтесь между заполненным или пронумерованным списком, включайте или выключайте якорные ссылки и выбирайте двухпространственный, четырехпространственный или табуляционный отступ.

  4. Скопируйте оглавление

    Скопируйте сгенерированную Markdown и вставьте ее в верхнюю часть документа. Каждая запись ссылается на соответствующий якорь заголовка.

Основные характеристики

  • Якоря, совместимые с GitHub

    Slugs соответствуют идентификаторам рендеров GitHub, включая числовые суффиксы для повторяющихся заголовков, поэтому каждая ссылка разрешается правильно.

  • Фильтрация уровней

    Включите только желаемые уровни заголовка. вложение измеряется по самому мелкому включенному заголовку, поэтому список, начинающийся с H2, остается заподлицо слева.

  • Заказано или незаказано

    Выведите список с выпуском или список с номерами со счетчиками для каждого уровня, с дополнительными ссылками привязки и настраиваемым отступом.

  • Код-блок Aware

    Заголовки, написанные внутри огражденных блоков кода, игнорируются, поэтому фрагменты примеров никогда не просачиваются в ваш контур.

Frequently Asked Questions

Оглавление Markdown - это список ссылок, указывающих на привязки заголовков в пределах одной страницы. каждому заголовку в документе Markdown присваивается автоматический идентификатор, и ссылка, написанная как [Раздел](#раздел), переходит к нему. Этот инструмент считывает ваши заголовки, строит соответствующие привязки и собирает для вас вложенный список.

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

markdown table of contentsmarkdown toc generatorgenerate tocmarkdown toctable of contents generatorgithub anchor linksreadme tocheading linksmarkdown outline