← Все инструменты для текста

Оглавление из заголовков

Создайте связанное оглавление из заголовков документа Markdown по правилам якорей GitHub, в виде маркированного или нумерованного списка.

  • Бесплатно
  • Без регистрации
  • Работает на любом устройстве

Около Оглавление из заголовков

Длинные README и страницы документации проще просматривать со связанным оглавлением. Этот генератор сканирует документ Markdown на заголовки, записанные знаками # или подчеркнутые = и -, игнорирует все внутри блоков кода и связывает каждый пункт с его якорем по правилам GitHub: строчные буквы, без знаков препинания, пробелы заменяются дефисами, а повторяющиеся заголовки нумеруются -1, -2. Выберите самый верхний и самый нижний уровень заголовков для включения и маркированный или нумерованный список, затем вставьте результат под свой заголовок.

Как пользоваться инструментом «Оглавление из заголовков»

  1. Вставьте документ Markdown в поле.
  2. Выберите уровни заголовков для включения и маркированный или нумерованный список.
  3. Скопируйте оглавление и вставьте его ближе к началу файла.

Чем полезен этот инструмент?

Другие названия

Частые вопросы

Как создаются ссылки-якоря?

Текст заголовка переводится в строчные, символы кроме букв, цифр, дефисов и подчеркиваний удаляются, а пробелы становятся дефисами. Так «Usage & API» ведет на #usage--api.

Что происходит с двумя заголовками с одинаковым названием?

GitHub добавляет второму заголовку суффикс -1, третьему -2 и так далее. Инструмент считает все заголовки документа так же, поэтому ссылки совпадают с тем, что показывает GitHub.

Работают ли якоря вне GitHub?

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

Инструмент «Оглавление из заголовков» бесплатный?

Да. Инструмент «Оглавление из заголовков» на Toolipedia бесплатный: без регистрации и водяных знаков.

Это безопасно?

Да. Все вычисления выполняются в браузере, и ничего из введённого не отправляется на наш сервер.

Работает ли это на телефоне?

Да. Работает в любом современном браузере на Android и iPhone, а также на планшетах и компьютерах. Ничего не нужно устанавливать.

Нужна ли учётная запись?

Нет. Просто откройте страницу и пользуйтесь. Ни регистрации, ни электронной почты не нужно.

Можно ли разместить Оглавление из заголовков на моём сайте?

Да. Нажмите кнопку «Встроить на свой сайт» под инструментом, чтобы скопировать короткий фрагмент кода и вставить его на страницу. Это бесплатно, аккаунт не нужен, и инструмент продолжает работать внутри вашей страницы.

Похожие инструменты