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

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

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

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

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

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

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

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

7 70
github wikipedia

7 ответов:

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

смотрите подробные инструкции в GitHub Wiki sidebar menu builder с многоуровневым.

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

74

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

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

этот процесс-заноза в заднице. Я удивлен, что этот" Голлум " Вики имеет какое-либо признание.

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

21

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

Enter image description here

теперь у вас есть страница, которую вы редактируете, как и любую другую Markdown

18

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

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

10

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

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

4

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

Enter image description here

3

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

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

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

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

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

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

  • клонируйте свой репозиторий GitHub 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 в папке репозитория 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

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

2