Вікі-каталоги GitHub


85

Чи підтримує wiki, що встановлюється за допомогою репозиторію GitHub, каталоги? Наша вікі захаращена сторінками, і ми шукаємо спосіб їх краще організувати.

Ми спробували витягнути репо, створити локальні каталоги та перемістити речі, але коли коміт повернувся назад, вікі не взяв змін.

Відповіді:


60

У мене була точно така ж проблема, і я пробував варіанти того, що ви пробували. Нічого не застрягло. Запитавши підтримку GitHub щодо цього, ми отримали відповідь, яка, по суті, сказала: "Ні, але ми повідомимо розробників, що люди зацікавлені в цій функції".

Тож коротка відповідь - «Ні», а довга - «Ні, але можливо в майбутньому».


8
Поточна коротка відповідь - "Так". :)
Марко

2
@Marco Через ТРИ роки? GitHub дійсно серйозно сприймає запити їх користувачів! : |
трейдер

9
Так, все ще ні, через п’ять років
Лінкольн Бергесон,

1
Шість років. До речі, люди чули, як вони стогнуть про те, що #Microsoft повернув #GitHub назад в офіс. Сьогодні у мене занадто багато розчарувань, і я думаю, що зараз можу їм посміятись.
DevOvercome

Ми можемо зробити це таким чином docs.gitlab.com/ee/user/project/wiki
Amrita Deb

30

Насправді, схоже, нещодавно github додав підтримку каталогів.

Я зміг зробити наступне:

  • Перемістіть наявний файл розмітки до нового каталогу.
  • Створіть новий файл розмітки в існуючому каталозі (створеному на попередньому кроці).
  • Створіть новий файл розмітки в новому каталозі.

У всіх випадках наявні сторінки все ще існували, а нові сторінки додавались.

Єдине обмеження, яке залишається, полягає в тому, що імена ваших файлів повинні бути унікальними. Якщо у вас є більше одного файлу з однаковим ім’ям, у вікі з’явиться лише один із них (я не впевнений, який ..).


9
Отже, це просто для організації ваших сторінок, але більше нічого не дає.
Рене Пот

26

Вікі GitHub (він же Gollum ) використовує каталоги, але не так, як ви можете очікувати.

Документація у вікі Gollum може зайняти певну роботу, але це те, що я з'ясував переважно за допомогою тестування.

  • Усі файли відображаються в кореневій частині вікі незалежно від того, де вони розміщені в репо.
  • _Header, _Footerа _Sidebarфайли належать до кожного каталогу, але успадковуються, якщо в дочірній папці їх немає.
  • Посилання на файли можуть мати відношення до вихідного файлу (зберігайте файли разом зі своїм вмістом).

Отже, якщо вам потрібні каталоги для простору імен, вам не пощастило. Подумайте про використання {namespace}-{page}схеми для простору імен.


7
відсутність підсторінок робить вікі Gollum та GitHub за розширенням скаліченою "вікі".

14

Це не ідеальне рішення, але обхідним шляхом було б створити власну бічну панель, де ви створюєте зміст із посиланнями на ваші сторінки. Я вважаю, що це все одно краще папок, оскільки це дозволяє мати посилання на одну сторінку в декількох ієрархіях.


Це такий підхід, який я застосував, але він залишає частину "Сторінки", яка становить величезну халепу сторінок (понад 60 у моєму проекті).
Джейсон Шорт

Частина Pages
згорнута, тому на

1

Насправді, обмеження все ще існують. Так, ви можете додати 1 рівень (отже, 1 підпапку). Але це все! Я переробив весь макет документації, створивши кілька рівнів підпапок для організації, але це було заборонено.

зітхати

Треба сказати: я вражений цією справою Голлума. Я здивований, що Github навіть взяв його.


2
Я не думаю, що це правильно. Я переглядав один із рекомендованих git вікі-сайтів, github.com/showcases/projects-with-great-wikis . Я зробив клон git, і впевнений, що у них є принаймні три рівні підкаталогів. Погляньте, наприклад, на технічну документацію / 1-трекери / рубі-трекер.
Ед Ост,

гаразд, я сам це перевірив, і, здається, у gollum проблеми з підкаталогами, які мають те саме ім'я, що навіть текст посилання. Це якось дивно. Я б зрозумів, якби сталося зіткнення у фактичній назві сторінки, але при використанні синтаксису mediaWiki [[Текст посилання | WikiPage]], справді, здається, плутається між текстом посилання та фактичною назвою каталогу.
Ed Ost

Цей неймовірно потворний та надлишковий формат, здається, працює [Ім'я сторінки] (Ім'я сторінки)
Ед Ост,

1
gollum-lib дозволяє іменам сторінок мати скісні риски, що поводиться так, як ви очікували. На жаль, ні GitHub, ні "офіційний" інтерфейс Gollum, що базується на Сінатрі, не підтримують їх розумно.
Гервіц

1
Ця вітрина github у коментарі Еда Оста більше не існує. Альтернативний fwiw quora.com/…
simesy
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.