ToC или боковая панель в GitHub Wiki

Question

Как мне создать ToC или боковое меню в GitHub Wiki?

Я видел некоторые упоминания об этом, и gollum, похоже, поддерживает его, но как мне это сделать в текущем проекте GitHub?

Лучше всего оно должно основываться на заголовках, которые у меня есть на странице автоматически.

Все ссылки упоминают об этом, но не показывают, как это сделать:

• https://gist.github.com/379469 - некоторый взлом JavaScript

• https://github.com/blog/774-git-powered-wikis-improved - GitHub упомянул это:

  "Вики GitHub имеют немного документированные возможности для нижних колонтитулов ибоковые панели, с которыми знакомы некоторые наши вики-разработчики на основе git. Новый редактор Wiki предоставляет вам ограниченное редактирование нижних колонтитулов и боковых панелей на вашем веб-сайте. "

Answer 1

Пока ваше решение работает, есть более простой способ сделать это с помощью веб-интерфейса GitHub. Вы можете просто создать страницу с именем _Sidebar и / или _Footer.

См. Подробные инструкции в Построитель боковых панелей Github Wiki с многоуровневым .

Редактировать Оригинальная статья пропала, и я не могу найти ее в кеше, поэтому я обновил ссылку.

Answer 2

Хорошо.Позвольте мне понять, правильно ли я понимаю:

1. Клонируйте вашу вики-страницу GitHub.(В вики есть раздел Git. Вы можете проверить свой подобный вики код.)
2. Создать _Sidebar.md
3. На обычных вики-страницах используйте [[link]] для боковой панели
4. Зафиксируйте и отправьте обратно на GitHub

Этот процесс вызывает боль в заднице.Я удивлен, что эта вики «gollum» имеет какое-либо признание.

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

Answer 3

Когда вы находитесь в вики вашего проекта, есть ссылка Добавить пользовательскую боковую панель .Щелкните по нему.

Теперь у вас есть страница, которую вы редактируете, как если бы вы редактировали любую другую страницу Уценка .Чтобы составить оглавление, вы должны сделать это вручную, хотя.Автоматизированного метода не существует (по состоянию на август 2014 года).Так, например:

# My menu
* [Home][home]
* [Technical documentation][techdocs]
* [User manual][usermanual]

[home]: https://github.com/myproject/wiki/Home
[techdocs]: https://github.com/myproject/wiki/Technical-documentation
[usermanual]: https://github.com/myproject/wiki/User-manual

Answer 4

Обратите внимание, что исходный вопрос был о создании боковой панели (легко, решается в ответах) или фактическом оглавлении (без ответа).

Одно могу сказать, что синтаксис вики gollum 2.1 допускает использование тега [[_TOC_]], но вики GitHub этого не распознают (пока?).

Answer 5

Я думаю, что это описано в Голлум README.(См. Разделы заголовка и боковой панели.)

По сути, вы делаете _footer.ext и _sidebar.ext в каталоге, содержащем содержимое страницы.

Answer 6

Я только что создал скрипт Python , который генерирует индекс в _Sidebar.md GitHub на основе структуры папок и страниц в вики-файле git.

Answer 7

Я реализовал модуль npm github-wiki-sidebar , чтобы помочь пользователям github легко создавать и поддерживать меню боковой панели.

Источник и результат: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Исходные страницы (как показано в вики-администрировании):

Home
Installation
Roadmap
Usage
Usage: Command line modifiers
Usage: Init Mode

Результат (в произвольном порядке):

• Домашняя страница
• Установка
• Использование
  • Режим инициализации
  • Модификаторы командной строки
• Дорожная карта

Предварительные требования:

• клонировать ваш github wikiлокально хранилище (отображается в правом нижнем углу пользовательского интерфейса Wiki)

• установить боковую панель github-wiki

  git clone <https://github.com/<username>/<my-project-name>.wiki.git
  npm install -g github-wiki-sidebar
  

Создать /обновите ваше вики-меню:

• создайте новые страницы / переименуйте страницы на вашем github.com wiki admin

• выполните локально скрипт github-wiki-sidebar в вашемпапка хранилища вики

  cd /path/to/<my-project-name>.wiki
  # this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github
  github-wiki-sidebar --git-push
  

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