collegamento github alla pagina wiki da README

91

Come creo un collegamento da un file README.md a una pagina Wiki in GitHub? Ogni esempio sembra mostrare il collegamento da una pagina wiki a un'altra pagina wiki, o da un file README a un altro file nel repository. Ma nessuno che mostri un collegamento dall'uno all'altro

github

— veilig
fonte

Hai ragione. "da un file README a un altro file nel repository" funziona, ref ufficiale help.github.com/articles/relative-links-in-readmes blog ufficiale github.com/blog/1395-relative-links-in-markup- file , vedere anche bibwild.wordpress.com/2013/01/30/… .

— Stéphane Gourichon

Approfondimento sul motivo per cui il collegamento da README a wiki non è così desiderabile: "Certo, potresti collegarti al tuo wiki, ma il wiki non è dotato di versione insieme al codice sorgente e vuoi collegarti alla versione dei documenti che lo accompagnano l'istantanea esatta del repository di origine che stai guardando. Certo, puoi collegarti utilizzando collegamenti ipertestuali URL assoluti, ma lo stesso problema, ti colleghi sempre al master, quando vuoi collegare il file nella stessa istantanea il lettore sta guardando il README in. " Fonte: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

67

Dovresti usare un URL assoluto invece di uno relativo.

Per esempio:

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

— maxdeviant
fonte

4

ok, questo è quello che pensavo - volevo solo assicurarmi che non ci fosse un modo migliore.

— velo

2

Nel documento collegato a da @ jmar777, mette in guardia sull'utilizzo di URL assoluti: "Gli utenti che clonano il tuo repository avranno molte più difficoltà a far funzionare i collegamenti del previsto".

— Dave Sexton

@DaveSexton Questo si riferisce specificamente al collegamento ad altri file nel repository (che sarà sempre relativo al README). Quando ci si collega a qualcosa di esterno (come un wiki), si desidera utilizzare URL assoluti.

— maxdeviant

92

Mi sono appena imbattuto in questa domanda e ho visto che era impossibile, ma continuai ostinatamente a provare comunque. Buone notizie, perché questo effettivamente si può fare con i relativi link!

Se guardi la documentazione per i collegamenti relativi su GitHub , puoi vedere che supporta ./e ../operandi.

Dato che il tuo README si trova in:

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

... e il wiki si trova in:

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

... questo significa che puoi semplicemente tornare indietro dal README al wiki, in questo modo:

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

Aggiornamento: come alcune persone hanno sottolineato nei commenti (grazie!), Tieni presente che questi collegamenti relativi si interromperanno su cloni e fork, quindi assicurati di valutarlo nella tua decisione!

— jmar777
fonte

15

Interessante, ma nota che README.md può essere visualizzato da un clone locale invece che dal web. In tal caso, l'unica cosa che funziona è un collegamento con URL assoluto.

— Stéphane Gourichon

1

Buon punto, @ StéphaneGourichon, non avevo considerato la visualizzazione locale del file Readme. Anche se suppongo che se si desiderano collegamenti relativi, questa è una limitazione accettabile.

— jmar777

2

È possibile clonare il wiki localmente come git separata Repo: stackoverflow.com/questions/15080848/...

— EriF89

3

Parola di avvertimento: quando si visualizzano singoli file come un README.mdBLOB specifico per un commit, questo non funzionerà.

— Kaiser

Come accennato da Stephane Gourichon, i link relativi non sono sempre la strada da percorrere. Un altro esempio è se desideri che il tuo pacchetto sia installabile tramite una piattaforma open source di terze parti. Per Python, questo è PyPi. PyPi verrà caricato nella descrizione, ma tutti i collegamenti relativi verranno interrotti. In questo caso, devi utilizzare URL assoluti.

— cgnorthcutt

1

Solo per aggiungere questo, se vuoi fare riferimento al tuo file repo dall'interno del wiki ../../blob/master/. In combinazione con la risposta di jmar777, ciò consente di integrare completamente codice e wiki e rimuovere la necessità di readme.md gonfio.

Per farlo funzionare a livello locale così come dovrebbe essere la struttura dei file

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

— DfAC
fonte

1

Ho scoperto che avevo bisogno di tornare indietro di 3 livelli rispetto a 2 livelli come descritto nell'approccio di jmar777.

Quando ho usato

../../wiki

Il collegamento generato era https://github.com/<username>/blob/wiki

Avevo bisogno di usare:

../../../wiki

Questo ha generato https://github.com/<username>/wiki

— Grendel
fonte

1

Sto usando GitLab. Il mio collegamento alla mia pagina Wiki è simile a questo.

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

Ho provato gli altri consigli che sono stati pubblicati qui, ma ha continuato a cambiare l'URL con riscritture che hanno interrotto il collegamento.

— LinuxGuru
fonte