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

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

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

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

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

  • https://gist.github.com/379469 - некоторые хаки JavaScript

  • https://github.com/blog/774-git-powered-wikis-improved - GitHub упоминает об этом:

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

ОТВЕТЫ

Ответ 1

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

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

Этот процесс - боль в заднице. Im удивил, что у этой "gollum" wiki есть признание.

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

Ответ 2

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

См. подробные инструкции в ДОБАВЛЕНИЕ СОДЕРЖАНИЯ В ВАШЕГО ГИТУМА WIKI.

Ответ 3

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

Enter image description here

Теперь у вас есть страница, которую вы редактируете, так как вы редактируете любую другую страницу Markdown. Чтобы сделать оглавление, вы должны сделать это вручную, хотя. Нет автоматизированного метода (по состоянию на август 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

Ответ 4

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

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

Ответ 5

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

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

Ответ 6

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

Введите описание изображения здесь

Ответ 7

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

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

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

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

Результат (с индивидуальным заказом):

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

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

  • установить github-wiki-sidebar

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

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

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

  • выполнить локально github-wiki-sidebar script в вашей папке репозитория wiki

    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

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