ToC або бічна панель у GitHub Wiki

87

Як створити ToC або меню бічної панелі в GitHub Wiki?

Я бачив деякі згадки про це, і, здається, серверний сервер підтримує це, але як це зробити в поточному проекті GitHub?

Найкраще це повинно базуватися на заголовках, які я маю на сторінці автоматично.

Усі ці посилання згадують про це, але не показують, як це зробити:

  • https://gist.github.com/379469 - якийсь злом JavaScript

  • https://github.com/blog/774-git-powered-wikis-improved - GitHub згадує про це:

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

github  wiki 
— вовк
джерело
3
Я розробив GitHub Wikifier: попередній коміт Git Hook, який сформує весь зміст, який вам коли-небудь знадобиться. Просто напишіть свій вміст і дозвольте йому взяти верх. Можливо, варто перевірити. github.com/kuroir/GitHub-Wikifier
— MarioRicalde
— Ciro Santilli 郝海东 冠状 病 病 事件 事件 法轮功
Код @MarioRicalde переміщено на github.com/hybridgroup/GitHub-Wikifier
— Джонні

Відповіді:

76

Поки ваше рішення працює, існує простіший спосіб зробити це за допомогою веб-інтерфейсу GitHub. Ви можете просто створити сторінку з іменем _Sidebarта / або _Footer.

Див. Детальні інструкції у багаторівневому конструкторі меню бічної панелі Github Wiki .

Редагувати Оригінальну статтю немає, і я не можу її знайти в кеші, тому оновив посилання.

— nicerobot
джерело
7
@CodeSherpa вони доступні в https://github.com/[user]/[repo]/wiki/_Sidebar/_editіhttps://github.com/[user]/[repo]/wiki/_Footer/_edit
— nicerobot
1
Стаття була чудовою, але містить неправильну (або застарілу) інформацію про те, як отримати URL-адресу вікі. Якщо ви загубилися так само, як і я, вам доведеться використовувати URL-адресу https://github.com/<username>/<projectname>.wiki.gitабо SSH git@github.com:<username>/<projectname>.wiki.git.
— NightOwl888
1
Ці докладні інструкції досить погані. Що таке [[link]]? Введення URL-адреси туди призводить до відображення всієї URL-адреси.
— Пітікос
3
@Pithikos - це Гітхуб Маркдаун. Інструкцій немає, щоб навчити вас Markdown. Вони там, щоб пояснити бічні панелі.
— nicerobot
2
@nicerobot, а найкращий спосіб щось пояснити - це на конкретному прикладі ..
— Пітікос,
26

Коли ви знаходитесь у вікі свого проекту, є посилання Додати власну бічну панель . Клацніть це.

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

Тепер у вас є сторінка, яку ви редагуєте, як і будь-яку іншу сторінку 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
— Пітікос
джерело
25

Добре. Дозвольте подивитися, чи правильно я це розумію:

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

Цей процес - біль у попі. Я здивований, що ця вікі “gollum” має якесь визнання.

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

— вовк
джерело
2
Згідно з документами, ви можете додавати різні бічні панелі для різних папок: "Бічні панелі впливають на всі сторінки в їх каталозі та будь-які підкаталоги, які не мають власного файлу бічної панелі." див .: github.com/github/gollum
— Subfuzion
10

Зверніть увагу, що оригінальне питання стосувалось створення бічної панелі (легко, вирішеної у відповідях) або фактичного змісту (без відповіді).

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

— позначка
джерело
4
Вам пощастило? Це страшенно засмучує, прийшовши з Trac, де всі ці речі було легко зробити.
— жарти
Я думаю, що краща відповідь на оригінальне запитання про те, як скласти зміст "на основі заголовків, які я маю на сторінці автоматично" - це те, що в даний час неможливо з GitHub Wiki.
— avernet
Наразі це відкрите питання (ліниво шукати кількість), яке коментували сотні людей. Поки що жодного слова з GitHub немає :(
— abalter
Основними проблемами GitHub, на які посилаються це станом на 19.01.2017, є: 1. Розмітка - Зміст 2. Вставте автоматично сформований зміст TOC у відтворені файли
— розмітки,
4

Я думаю, що це описано в ГоллуміREADME . (Див. Розділи заголовка та бічної панелі.)

По суті, ви робите a _footer.extі _sidebar.extв каталозі, що містить вміст сторінки.

— сіндаві
джерело
2

Я застосував модуль 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

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

Попередні вимоги:

  • клонуйте свій репозиторій wiki github локально (відображається внизу праворуч від інтерфейсу Wiki)

  • встановіть github-wiki-бічну панель

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

Створіть / оновіть своє меню вікі:

  • створювати нові сторінки / перейменовувати сторінки у своєму адміністраторі wiki github.com

  • виконайте локально скрипт github-wiki-бічної панелі у вашій папці сховища 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

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

— адтанаса
джерело
0

GitHub автоматично генерує зміст документа:

  1. Зробіть документ типу AsciiDoc замість Markdown.
  2. Вставити :toc:на початку документа.
— Собачий погода
джерело
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.