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

87

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

Мы пытались вытащить репо, создать локальные каталоги и переместить что-то, но после фиксации назад вики не уловила изменения.

github wiki Джон Ливермор
источник

Ответы:

60

У меня была такая же проблема, и я пробовал варианты того, что вы пробовали. Ничего не прилипло. Спросили об этом в поддержке GitHub и получили ответ, в котором по сути говорилось: «Нет, но мы дадим разработчикам знать, что люди заинтересованы в этой функции».

Таким образом, короткий ответ - «Нет», а длинный ответ - «Нет, но, возможно, в будущем».

Коллин М
источник
8
Текущий краткий ответ - «Да». :)
Марко
2
@ Марко Спустя ТРИ года? GitHub действительно серьезно относится к запросам своих пользователей! : |
Trejder
9
Да, все еще нет, пять лет спустя
Линкольн
1
Шесть лет. Кстати, слышал, как люди стонут о том, что #Microsoft вернула #GitHub в офис. Сегодня у меня слишком много разочарований, и я думаю, что теперь могу посмеяться им в глаза.
DevOvercome 05
Мы можем сделать это так docs.gitlab.com/ee/user/project/wiki
Амрита Деб
30

Собственно, похоже, что github недавно добавил поддержку каталогов.

Мне удалось сделать следующее:

  • Переместите существующий файл уценки в новый каталог.
  • Создайте новый файл уценки в существующем каталоге (созданном на предыдущем шаге).
  • Создайте новый файл уценки в новом каталоге.

Во всех случаях существующие страницы оставались там, и были добавлены новые страницы.

Остается одно ограничение: имена файлов должны быть уникальными. Если у вас есть несколько файлов с одинаковыми именами, только один из них будет отображаться в вики (я не уверен, какой ..).

Марко
источник
9
По сути, это просто для организации ваших страниц, но больше ничего вам не дает.
Рене Пот
26

Вики GitHub (также известная как Gollum ) использует каталоги, но не так, как вы ожидаете.

Документация на вики Gollum может потребовать некоторой работы, но это то, что я выяснил в основном путем тестирования.

  • Все файлы появляются в корне вики независимо от того, где они размещены в репо.
  • _Header, _Footerи _Sidebarфайлы относятся к каталогам, но наследуются, если их нет в дочерней папке.
  • Ссылки на файлы могут относиться к исходному файлу (сохраняйте файлы вместе с содержимым).

Итак, если вам нужны каталоги для размещения имен, вам не повезло. Рассмотрите возможность использования {namespace}-{page}схемы для размещения имен.

Кевин Кокс
источник
7
Отсутствие подстраниц делает вики Gollum и GitHub, как следствие, уродливой «вики».
14

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

Тхань Нгуен
источник
Я выбрал именно такой подход, но он оставляет часть «Страницы», которая представляет собой огромное количество страниц (более 60 в моем проекте).
Джейсон Шорт
Часть страниц свернута, поэтому, к счастью, она не загромождает боковую панель
pd12 05
1

Собственно, ограничение все же есть. Да, вы можете добавить 1 уровень (то есть 1 подпапку). Но это все! Я реорганизовал весь макет моей документации, создав несколько уровней вложенных папок для организации, но это было бесполезно.

вздох

Должен сказать: я потрясен этой штукой с Голлумом. Я удивлен, что Github даже поднял его.

Gjoris
источник
2
Я не думаю, что это правильно. Я просматривал один из рекомендуемых git вики-сайтов, github.com/showcases/projects-with-great-wikis . Я сделал клон git, и, конечно же, у них есть как минимум три уровня подкаталогов. Взгляните, например, на техническую документацию / 1-трекеры / ruby-tracker.
Эд Ост
хорошо, я тестировал это сам, и кажется, что у gollum есть проблема с подкаталогами, которые имеют то же имя, что и текст ссылки. Это немного странно. Я бы понял, если бы произошло противоречие в фактическом имени страницы, но при использовании синтаксиса mediaWiki [[Текст ссылки | WikiPage]] действительно кажется, что возникает путаница между текстом ссылки и фактическим именем каталога.
Эд Ост
Этот невероятно уродливый и избыточный формат, кажется, работает [PageName] (PageName)
Эд Ост
1
gollum-lib позволяет использовать косые черты в именах страниц, что вполне ожидаемо. К сожалению, ни GitHub, ни "официальный" интерфейс Gollum на основе Sinatra не поддерживают их.
Gerwitz
1
Эта витрина на github в комментарии Эда Оста больше не существует. Альтернативный fwiw quora.com/…
simesy