Что такое генератор таблицы содержания разметки?
Генератор оглавления 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?
Вставьте свой уценка
Бросьте свой полный документ Markdown или README во входное поле. Заголовки внутри огражденных блоков кода пропускаются автоматически.
Выберите уровни заголовков
Установите самые мелкие и глубокие уровни, чтобы включить. Распространенный выбор - от H2 до H3, который сохраняет контур читаемым без перечисления каждого подраздела.
Выберите стиль списка
Переключайтесь между заполненным или пронумерованным списком, включайте или выключайте якорные ссылки и выбирайте двухпространственный, четырехпространственный или табуляционный отступ.
Скопируйте оглавление
Скопируйте сгенерированную Markdown и вставьте ее в верхнюю часть документа. Каждая запись ссылается на соответствующий якорь заголовка.
Основные характеристики
Якоря, совместимые с GitHub
Slugs соответствуют идентификаторам рендеров GitHub, включая числовые суффиксы для повторяющихся заголовков, поэтому каждая ссылка разрешается правильно.
Фильтрация уровней
Включите только желаемые уровни заголовка. вложение измеряется по самому мелкому включенному заголовку, поэтому список, начинающийся с H2, остается заподлицо слева.
Заказано или незаказано
Выведите список с выпуском или список с номерами со счетчиками для каждого уровня, с дополнительными ссылками привязки и настраиваемым отступом.
Код-блок Aware
Заголовки, написанные внутри огражденных блоков кода, игнорируются, поэтому фрагменты примеров никогда не просачиваются в ваш контур.
Frequently Asked Questions
Related Tools
HTML Table Generator
Generate an accessible HTML table from pasted CSV or tab-separated data. Add a header row, caption, striped rows, and borders, then copy the HTML and CSS. Runs client-side.
HTML to Markdown
Convert HTML to clean Markdown instantly. Turns headings, lists, links, images, blockquotes, code blocks and tables into portable GitHub Flavored Markdown. Tolerant of messy CMS markup. Runs client-side.
Markdown to HTML
Convert Markdown to clean, semantic HTML with GitHub Flavored Markdown support - tables, task lists, fenced code, heading anchors, live preview and a full HTML document export.
WordPress Readme Generator
Write a plugin readme.txt the WordPress.org directory parses, with a live preview of the listing it produces and a download when it is right.
Comments
0 comments
No comments yet. Be the first to share your thoughts!