Как создать какую-либо таблицу содержимого в вики GitHub?

Ответ 1

Это хорошо продемонстрировано в оглавлении Markdown Cheatsheet.

##### Table of Contents  
[Headers](#headers)  
[Emphasis](#emphasis)  
...snip...    
<a name="headers"/>
## Headers

Если вы наведите указатель мыши на заголовок в файле GitHub Markdown, вы увидите небольшую ссылку слева от него, вы также можете использовать эту ссылку. Формат для этой ссылки <project URL#<header name>. <header name> должен быть всем нижним регистром.

Ответ 2

Одним возможным (полуавтоматизированным) решением является Евгений Калинин github-markdown-toc. Этот инструмент по существу хрустит через ваш README.md файл и snarfs out # заголовки для создания TOC.

• Загрузите script https://github.com/ekalinin/github-markdown-toc

• Загрузите README.md в script (как указано в Eugene README.md)

  cat README.md | bash github-markdown-toc

• Вырезать и вставить созданный TOC и поместить его вверху вашего файла README.md

Обратите внимание, что эта реализация bash работает только с Linux (из того, что я могу сказать).

В качестве побочной заметки существует golang реализация и, вероятно, больше хлопот, чтобы работать.

Ответ 3

https://github.com/jonschlinkert/markdown-toc

• git clone your-repo.wiki.git (добавьте .wiki прямо перед .git чтобы клонировать вики
• npm я -g markdown-toc
• Вставьте <!-- toc --> (с учетом регистра) в вашу вики-разметку
• markdown-toc -i my-wiki-markdown.md (-i отредактирует его на месте)
• прибыль

Обновление: я думаю, что https://github.com/thlorenz/doctoc сейчас более популярен.

Ответ 4

В настоящее время это невозможно сделать с использованием синтаксиса уценки (.md). В настоящее время продолжается неофициальное обсуждение автоматического создания оглавления оглавления для визуализированных файлов README.md таких как README.md котором перечислены некоторые идеи.

Однако есть и другие обходные пути, такие как:

• AsciiDoc этого используйте AsciiDoc согласно предложению из этого комментария. Например:

  :toc: macro
  :toc-title:
  :toclevels: 99
  # Title
  
  toc::[]
  
  ## A
  
  ### A2
  
  ## B
  
  ### B2
  

  Проверьте пример на littlebits/react-popover (README.adoc).

• Онлайновый генератор контента (raychenon/play-of-content)

• arthurhammer/github-toc - расширение браузера, которое добавляет оглавление в репозитории GitHub

Ответ 5

Если вы не в состоянии придерживаться Markdown, вы можете сделать следующее:

• на GitHub/wiki: переключите Markdown на MediaWiki. Используйте синтаксис __TOC__. Смотрите образец.
• на GitHub/repo: переключите Markdown на AsciiDoc. Использование :toc: Синтаксис. Смотрите демо.

Однако, используя файлы Markdown в GitHub/repo, вы можете получить их на страницах GitHub, как в Википедии

• когда Jekyll активирован, он генерирует страницы GitHub с использованием Kramdown по умолчанию
• Kramdown поставляется с Table Of Content. Используйте синтаксис {:toc}. Смотрите объяснение.

Ответ 6

Вы можете выбрать режим редактирования "MediaWiki", который будет генерировать toc для заголовков, например.

== First ==

== Second ==

Ответ 7

Так как GitHub не может использовать TOC напрямую, но у нас есть другие альтернативы.

Вы можете автоматически генерировать TOC с помощью онлайн-инструмента:

Генерация оглавления оглавления из GitHub Markdown или Wiki Online

или через локальный инструмент:

GitHub-уценки-TOC

Ответ 8

Самое простое решение для меня (хотя у меня всегда установлен сервер node.js и поскольку в npm есть npx), выполняется npx markdown-toc. Кажется, это одно из самых популярных решений этой задачи:

ls
cat <<EOF >> test.md | tee 
## Table of Contents

<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->

## abc
This is a b c.

## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md

выход:

Ответ 9

Действительно простой и быстрый результат - http://tableofcontent.eu/