link do github para a página wiki do README

92

Como faço para criar um link de um arquivo README.md para uma página Wiki no github? Cada exemplo parece mostrar links de uma página wiki para outra página wiki, ou de um arquivo README para outro arquivo no repositório. Mas nenhum que mostre ligando de um para o outro

github

— velar
fonte

Você está certo. "a partir de um arquivo README para outro arquivo no repositório" funcionar, ref oficial help.github.com/articles/relative-links-in-readmes blog oficial github.com/blog/1395-relative-links-in-markup- arquivos , consulte também bibwild.wordpress.com/2013/01/30/… .

— Stéphane Gourichon

Perspicaz sobre por que o link do README para o wiki não é tão desejável: "Claro, você poderia criar um link para o seu wiki - mas o wiki não é versionado junto com o código-fonte, e você deseja vincular a versão dos documentos que acompanham o instantâneo exato do repositório de origem que você está vendo. Claro, você poderia criar um link usando hiperlinks de URL absolutos - mas mesmo problema, você está sempre vinculando ao mestre, quando deseja vincular ao arquivo no mesmo instantâneo do leitor está olhando para o README em. " Fonte: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

68

Você teria que usar um URL absoluto ao invés de um relativo.

Por exemplo:

[Sites Using React](https://github.com/facebook/react/wiki/Sites-Using-React)

— maxdeviant
fonte

4

ok, foi o que pensei - só queria ter certeza de que não havia uma maneira melhor.

— veilig

2

No documento vinculado por @ jmar777, ele alerta sobre o uso de URLs absolutos: "Os usuários que clonarem seu repositório terão muito mais dificuldade para fazer com que os links funcionem do que o esperado."

— Dave Sexton

@DaveSexton Isso se refere especificamente a links para outros arquivos no repositório (que sempre serão relativos ao README). Ao fazer um link para algo externo (como um wiki), você deseja usar URLs absolutos.

— maxdeviant

94

Acabei de encontrar essa pergunta e vi que isso era impossível, mas teimosamente continuei tentando de qualquer maneira. Boas notícias, porque isso realmente pode ser feito com links relativos!

Se você olhar a documentação para links relativos no GitHub , verá que ele suporta ./e ../operandos.

Dado que seu README está localizado em:

https://github.com/<user-name>/<repo-name>/blob/master/README.md

... e o wiki está localizado em:

https://github.com/<user-name>/<repo-name>/wiki

... isso significa que você pode simplesmente rastejar de volta do README para o wiki, assim:

[My Awesome Wiki](../../wiki)

Atualização: como algumas pessoas apontaram nos comentários (obrigado!), Esteja ciente de que esses links relativos quebrarão em clones e garfos, então certifique-se de pesar isso em sua decisão!

— jmar777
fonte

15

Interessante, mas observe que o README.md pode ser visto de um clone local ao invés da web. Nesse caso, a única coisa que funciona é um link com URL absoluta.

— Stéphane Gourichon

1

Muito bem, @ StéphaneGourichon, não pensei em ver o Readme localmente. Embora eu suponha que se os links relativos são desejados, essa é uma limitação aceitável.

— jmar777

2

Você pode clonar o wiki localmente como um

— repositório

3

Aviso: ao visualizar arquivos únicos como um README.mde um blob específico para um commit, isso não funcionará.

— Kaiser de

Conforme mencionado por Stephane Gourichon, os links relativos nem sempre são o caminho a percorrer. Outro exemplo é se você deseja que seu pacote seja instalável por meio de uma plataforma de código aberto de terceiros. Para Python, isso é PyPi. PyPi irá carregar na descrição, mas todos os links relativos serão quebrados. Você precisa ir com URLs absolutos neste caso.

— cgnorthcutt

1

Apenas para adicionar este, se você quiser se referir ao seu arquivo repo de dentro do wiki ../../blob/master/. Combinado com a resposta de jmar777, isso permite integrar completamente o código e o wiki e remover a necessidade de readme.md inchado.

Para fazer funcionar localmente, bem como sua estrutura de arquivos teria que ser

./Wiki/YourWikiRepo
./blob/master/YourCodeRepo

— DfAC
fonte

1

Eu descobri que precisava rastejar de volta 3 níveis contra 2 níveis, conforme descrito na abordagem de jmar777.

Quando eu usei

../../wiki

O link gerado foi https://github.com/<username>/blob/wiki

Eu precisava usar:

../../../wiki

Isso gerou https://github.com/<username>/wiki

— Grendel
fonte

1

Estou usando o GitLab. Meu link para minha página Wiki se parece com isto.

Checkout the [Wiki page](/%2E%2E/wikis/Welcome)

Eu tentei as outras recomendações que são postadas aqui, mas continuei mudando a URL com reescritas que quebraram o link.

— LinuxGuru
fonte