Автоматический TOC в github-flavored-markdown - PullRequest
200 голосов
/ 15 марта 2012

Можно ли сгенерировать автоматическое оглавление, используя Github Flavored Markdown ?

Ответы [ 14 ]

1 голос
/ 12 марта 2015

Мой коллега @schmiedc и я создали скрипт GreaseMonkey , который устанавливает новую кнопку TOC слева от кнопки h1, которая использует отличную библиотеку markdown-js для добавления / обновления таблицы содержание.

Преимущество перед такими решениями, как doctoc, заключается в том, что оно интегрируется в вики-редактор GitHub и не требует, чтобы пользователи работали в командной строке (и требует от пользователей установки таких инструментов, как node.js). В Chrome он работает путем перетаскивания на страницу «Расширения», в Firefox вам необходимо установить расширение GreaseMonkey.

Он будет работать с простой разметкой (то есть он не обрабатывает блоки кода правильно, так как это расширение GitHub для разметки). Взносы приветствуются.

0 голосов
/ 28 ноября 2017

Для Github's Texteditor Atom проверьте этот удивительный плагин (или "пакет" в Atom-lingo), который генерирует "TOC (оглавление) заголовков изанализируемая уценка " файлы:

markdown-toc

После установки в качестве пакета Atom вы можете использовать ярлык ctrl-alt-c для вставки оглавления в соответствии с вашей структурой документа markdown в текущей позиции курсора ...

Снимки экрана:

enter image description here

Назначение клавиш Atom

markdown-toc дает следующие привязки клавиш по умолчанию для управления плагином в Atom:

  • ctrl-alt-c => создать оглавление в позиции курсора
  • ctrl-alt-u => обновить оглавление
  • ctrl-alt-r => удалить оглавление

ПлагинОсобенности (из проекта README)

  • Автоматическое связывание через теги привязки, например, # A 1#a-1
  • Контроль глубины [1-6] с depthFrom:1и depthTo:6
  • Включить илиотключить ссылки с помощью withLinks:1
  • Обновить список при сохранении с помощью updateOnSave:1
  • Использовать упорядоченный список (1...., 2. ...) с orderedList:0
0 голосов
/ 27 июля 2017

В настоящее время невозможно с использованием синтаксиса уценки (см. Текущее обсуждение на GitHub ), однако вы можете использовать некоторые внешние инструменты, такие как:


В качестве альтернативы используйте вместо этого AsciiDoc (например, README.adoc), например,

:toc: macro
:toc-title:
:toclevels: 99
# Title

## A

### A2

## B

### B2

как предложено в этом комментарии . Проверьте демо здесь .

0 голосов
/ 23 декабря 2016

Это не прямой ответ на этот вопрос, так как многие люди нашли обходные пути. Я не думаю, что генерация оглавления уже официально поддерживается Github. Если вы хотите, чтобы GitHub автоматически отображал оглавление на своих страницах предварительного просмотра GFM, примите участие в обсуждении официального вопроса о запросе функции .

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...