Diretórios wiki do GitHub

87

O wiki que é instalado com um repositório GitHub oferece suporte a diretórios? Nosso wiki está repleto de páginas, e estamos procurando uma maneira de organizá-las melhor.

Tentamos puxar o repo, criar diretórios locais e mover as coisas, mas quando confirmado de volta, o wiki não pegou as mudanças.

John Livermore
fonte

Respostas:

60

Eu estava tendo exatamente o mesmo problema e tentei variantes do que você tentou. Nada travou. Perguntei ao suporte do GitHub sobre isso e recebeu uma resposta que basicamente dizia "Não, mas vamos deixar os desenvolvedores saberem que as pessoas estão interessadas neste recurso."

Portanto, a resposta curta é "Não" e a resposta longa é "Não, mas talvez no futuro".

Collin M
fonte
8
A resposta curta atual é "Sim". :)
Marco
2
@Marco depois de TRÊS anos? O GitHub realmente leva a sério a solicitação do usuário! : |
trejder
9
Sim, ainda não, cinco anos depois
Lincoln Bergeson
1
Seis anos. A propósito, ouvi pessoas reclamando sobre a #Microsoft que trouxe o #GitHub de volta ao escritório. Hoje tenho muitos decepcionantes e acho que posso rir deles agora.
DevOvercome
Podemos fazer desta forma docs.gitlab.com/ee/user/project/wiki
Amrita Deb
30

Na verdade, parece que o github adicionou suporte para diretórios recentemente.

Consegui fazer o seguinte:

  • Mova um arquivo markdown existente para um novo diretório.
  • Crie um novo arquivo markdown em um diretório existente (criado na etapa anterior).
  • Crie um novo arquivo de redução em um novo diretório.

Em todos os casos, as páginas existentes ainda estavam lá e novas páginas foram adicionadas.

A única restrição que permanece é que os nomes dos arquivos devem ser exclusivos. Se você tiver mais de um arquivo com o mesmo nome, apenas um deles aparecerá no wiki (não tenho certeza de qual ..).

Marco
fonte
9
Então, basicamente, é apenas para organizar suas páginas, mas não fornece nada mais.
Rene Pot
26

O wiki do GitHub (também conhecido como Gollum ) usa diretórios, mas não da maneira que você espera.

A documentação no wiki Gollum pode dar certo, mas isso é o que descobri principalmente por meio de testes.

  • Todos os arquivos aparecem na raiz do wiki, não importa onde sejam colocados no repo.
  • _Header, _Footere os _Sidebararquivos são por diretório, mas são herdados se não houver nenhum presente em uma pasta filho.
  • Os links de arquivo podem ser relativos ao arquivo de origem (mantenha seus arquivos com seu conteúdo).

Portanto, se você deseja diretórios para namespacing, não tem sorte. Considere usar o {namespace}-{page}esquema de namespacing.

Kevin Cox
fonte
7
a falta de subpáginas torna o wiki de Gollum e GitHub, por extensão, um "wiki" inválido.
14

Não é a solução ideal, mas a solução alternativa seria criar uma barra lateral personalizada onde você cria um índice analítico com links para suas páginas. Acho que isso é melhor do que pastas, porque permite que você tenha um link para uma única página em várias hierarquias.

Thanh Nguyen
fonte
Essa é a abordagem que tomei, mas deixa uma parte "Páginas" que é uma grande confusão de páginas (mais de 60 em meu projeto).
Jason Short
A parte do Pages está recolhida para não bagunçar a barra lateral, felizmente
pd12
1

Na verdade, ainda existe uma limitação. Sim, você pode adicionar 1 nível (portanto, 1 subpasta). Mas é isso! Refatorei todo o layout de minha documentação, criando vários níveis de subpastas para organização, mas não foi possível.

suspiro

Devo dizer: estou chocado com essa coisa do Gollum. Estou surpreso que o Github o tenha pego.

gjoris
fonte
2
Eu não acho que isso seja correto. Eu estava olhando um dos sites wiki recomendados pelo git, github.com/showcases/projects-with-great-wikis . Eu fiz um clone do git e com certeza eles têm pelo menos três níveis de subdiretórios. Dê uma olhada na documentação técnica / 1-trackers / ruby-tracker por exemplo.
Ed Ost de
ok, eu mesmo testei e parece que o gollum tem problemas com subdiretórios que têm o mesmo nome do texto do link. Isso é meio estranho. Eu entenderia se houvesse uma colisão no nome da página real, mas ao usar a sintaxe do mediaWiki [[Texto do Link | WikiPage]] realmente parece confuso entre o Texto do Link e o nome do diretório real.
Ed Ost de
Este formato incrivelmente feio e redundante parece funcionar [PageName] (PageName)
Ed Ost
1
gollum-lib permite que nomes de páginas tenham barras, que se comportam como você espera. Infelizmente, nem o GitHub nem o frontend "oficial" Gollum baseado em Sinatra suportam isso de forma sensata.
gerwitz
1
Aquele showcase do github no comentário de Ed Ost não existe mais. Uma alternativa fwiw quora.com/…
simesy