Генератар Markdown TOC (аўтаматычна па загалоўках)

Аўтаматычна стварайце Table of Contents па загалоўках Markdown. Выберыце ўзроўні загалоўкаў (напрыклад, H2-H4), пасля чаго скапіруйце рэдагуемы вынік і адразу ўстаўце яго.

Падтрымліваюцца H2-only, рэжымы anchor і дублікаты загалоўкаў без дадатковай наладкі.

Ваш тэкст застаецца лакальным у браўзеры і ніколі не загружаецца.

Як карыстацца (30 сек)

  1. Устаўце свой Markdown-тэкст.
  2. Выберыце ўзроўні загалоўкаў (H2-only / H2-H4 і г.д.).
  3. Скапіяйце згенераваны TOC і ўстаўце яго ў свой дакумент.

Прыклад уваходу і выніку

Прыклад з дублікатаў загалоўкаў

Увод

# Назва дакумента
## Агляд
## Выкарыстанне
### Усталяванне
### Налады
## FAQ
## FAQ

Вынік (H2-H3 / bullet list / TOC heading УКЛ)

## Table of contents

- [Агляд](#агляд)
- [Выкарыстанне](#выкарыстанне)
  - [Усталяванне](#усталяванне)
  - [Налады](#налады)
- [FAQ](#faq)
- [FAQ](#faq-2)

Спецыфікацыя (правілы anchor і дублікатаў)

Правілы выцягвання загалоўкаў

  • Выцягваюцца загалоўкі ATX (# да ####) у абраным дыяпазоне.
  • Ігнаруюцца радкі ўнутры fenced code block (``` ... ```).
  • Выкарыстоўвайце фільтр узроўняў (H2 only / H2-H3 / H2-H4 / H1-H4).
  • Setext headings (=== / ---) не ўключаны ў першую версію.

Правілы генерацыі anchor (правіла інструмента)

  1. Абрэзаць тэкст загалоўка.
  2. Пераводзіць літары лацінскага алфавіту ў ніжні рэгістр.
  3. Пераўтвараць прабелы ў '-'.
  4. Выдаляць сімвалы, акрамя '-'.
  5. Зліваць паўторныя '--' у '-'.
  6. Абрэзаць '-' у пачатку і канцы.
  7. Дадаваць -2, -3 ... калі ўзнікаюць дублікаты anchor.

Паводзіны TOC-спасылак могуць адрознівацца ў залежнасці ад платформы хостынгу і Markdown-viewer. Пры неабходнасці адрэдагуйце вынік.

FAQ

Ці магу я стварыць TOC толькі для H2?

Так. У Heading levels выберыце "H2 only".

Як вызначаецца тэкст anchor?

Anchor ствараецца паводле правіла, апісанага на гэтай старонцы. Таксама можна выбраць "Custom" або адрэдагаваць вынік уручную.

Як апрацоўваюцца дублікаты загалоўкаў?

Дублікаты загалоўкаў атрымліваюць suffix накшталт -2, -3, каб anchor заставаліся ўнікальнымі.

Ці магу я выключыць пэўныя загалоўкі з TOC?

Так. Выкарыстоўвайце Exclude keywords у пашыраных наладах.

Ці магу я згенераваць TOC без спасылак?

Так. Выберыце anchor mode "No anchors".

Заўвагі

  • Паводзіны anchor адрозніваюцца ў залежнасці ад Markdown-асяроддзя.
  • Вынік можна рэдагаваць, таму вы можаце дакладна падладзіць яго пад свой renderer.
  • Уваходны тэкст апрацоўваецца лакальна ў вашым браўзеры.

Звязаныя інструменты