Вхідних даних ще немає.
Зміст із якорями GitHub
Цей генератор змісту Markdown будує зміст файлу за його заголовками з посиланнями-якорями, які збігаються з якорями GitHub і GitLab. Вставте README й скопіюйте зміст або завантажте документ, у якому зміст уже вставлено між маркерами.
Оновлено:
Як це працює
Вставте Markdown
Вставте README, відкрийте файл .md або отримайте його за URL. Заголовки всередині блоків коду й HTML-коментарів ігноруються.
Виберіть рівні й стиль
Укажіть, які рівні заголовків включати, маркери чи номери, відступ, а також якорі GitHub або GitLab.
Скопіюйте або вставте
Скопіюйте лише список або візьміть увесь документ: зміст розміщується між маркерами <!-- toc -->, а наявний блок змісту замінюється.
Можливості
Якорі точно як на GitHub
Якорі будуються за правилами github-slugger: малі літери, без розділових знаків, пробіли — дефіси, а повторювані заголовки нумеруються -1, -2 у межах усієї сторінки.
Безпечний повторний запуск
Розпізнаються маркери markdown-toc (<!-- toc -->), Markdown All in One (<!-- TOC -->) і doctoc, тож оновлений зміст ніколи не дублюється.
Чистий текст посилань
Жирний шрифт, курсив, вбудований код і посилання в заголовках зводяться до видимого тексту — так, як заголовок читається після рендерингу.
Заголовки Setext теж
Окрім заголовків із #, знаходяться й заголовки, підкреслені === або ---.
Перевірка кожного якоря
На вкладці «Якорі» кожен заголовок показано з рівнем і згенерованим #якорем — зручно, щоб посилатися на розділ з інших сторінок.
Обмеження та конфіденційність
Документи розміром до 5 MB; великі обробляються у фоновому потоці (Web Worker), тож введення тексту не гальмує. Зміст створюється у вашому браузері, а файл ніколи не надсилається на сервер. Докладніше — на сторінці конфіденційності.
Часті запитання
Як додати зміст до README на GitHub?
Вставте README, залиште якорі GitHub і діапазон H2–H3 та завантажте документ. Зміст з’явиться під назвою між маркерами <!-- toc -->.
Чому посилання на якорі не працюють?
Якорі залежать від платформи. GitHub прибирає розділові знаки й лишає подвійні дефіси, GitLab зливає їх в один. Виберіть платформу, на якій відображатиметься файл.
Що з однаковими заголовками?
Як і на GitHub, другий заголовок «Usage» отримує якір #usage-1, третій — #usage-2. Приховані чи пропущені заголовки теж враховуються.
Чи можна оновити наявний зміст?
Так. Якщо в документі вже є зміст між відомими маркерами, замінюється лише цей блок, а решта файлу лишається незмінною байт у байт.
Чи можна зробити нумерований зміст?
Виберіть «1. item» у полі «Стиль списку». Кожен рівень нумерується окремо й має відступ під текстом батьківського пункту.
Чи має назва документа бути в змісті?
Зазвичай ні. Параметр «Пропустити назву (перший H1)» не включає перший H1, тож список починається з розділів.