README'den wiki sayfasına github bağlantısı

91

README.md dosyasından github'daki bir Wiki sayfasına nasıl bağlantı oluşturabilirim? Her örnek, bir wiki sayfasından başka bir wiki sayfasına veya bir README dosyasından arşivdeki başka bir dosyaya bağlantı gösteriyor gibi görünüyor. Ama hiçbiri birinden diğerine bağlantı göstermiyor

github

— peçe
kaynak

Haklısın. "bir README dosyasından bilgi havuzundaki başka bir dosyaya" işe yarıyor, resmi ref help.github.com/articles/relative-links-in-readmes official blog github.com/blog/1395-relative-links-in-markup- dosyaları , ayrıca bibwild.wordpress.com/2013/01/30/… bakın .

— Stéphane Gourichon

README'den wiki'ye bağlantının neden bu kadar cazip olmadığı konusunda bilgili: "Elbette, wiki'nize bağlantı kurabilirsiniz - ancak wiki, kaynak koduyla birlikte sürümlendirilmemiştir ve bununla birlikte gelen belgelerin sürümüne bağlantı vermek istiyorsunuz. baktığınız kaynak deponun tam anlık görüntüsü. Elbette, mutlak URL köprüleri kullanarak bağlantı kurabilirsiniz - ancak aynı sorun, her zaman ana kopyaya bağlanıyorsunuz, aynı anlık görüntüdeki dosyaya bağlantı vermek istediğinizde okuyucu içindeki BENİOKU'ya bakıyor. " Kaynak: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

67

Göreli bir URL yerine mutlak bir URL kullanmanız gerekir.

Örneğin:

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

— Maxdeviant
kaynak

4

Tamam, düşündüğüm buydu - sadece daha iyi bir yol olmadığından emin olmak istedim.

— veilig

2

@ Jmar777 ile bağlantı verilen dokümanda, mutlak URL'lerin kullanılması konusunda uyarıda bulunuyor: "Deponuzu klonlayan kullanıcılar, bağlantıların çalışmasını beklediğinden çok daha zorlayacak."

— Dave Sexton

@DaveSexton Bu, özellikle depodaki diğer dosyalara (her zaman README'ye göre olacak) bağlantıya atıfta bulunur. Harici bir şeye (wiki gibi) bağlantı verirken, mutlak URL'ler kullanmak istersiniz.

— maxdeviant

93

Az önce bu soruyla karşılaştım ve bunun imkansız olduğunu gördüm, ama yine de inatla denemeye devam ettim. İyi haber, çünkü bu aslında göreli bağlantılarla yapılabilir!

GitHub'daki göreli bağlantıların belgelerine bakarsanız, desteklediğini ./ve../ işlenenleri görebilirsiniz.

README’nizin şu adreste bulunduğu göz önüne alındığında:

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

... ve wiki şu adreste bulunur:

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

... bu, README'den wiki'ye geri dönebileceğiniz anlamına gelir, örneğin:

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

Güncelleme: Bazı kişilerin yorumlarda belirttiği gibi (teşekkürler!), Lütfen bu ilgili bağlantıların klonlarda ve çatallarda kırılacağını unutmayın, bu yüzden bunu kararınızda tarttığınızdan emin olun!

— jmar777
kaynak

15

İlginç, ancak README.md dosyasının web yerine yerel bir klondan görüntülenebileceğine dikkat edin. Bu durumda, çalışan tek şey mutlak URL'ye sahip bir bağlantıdır.

— Stéphane Gourichon

1

İyi bir nokta @ StéphaneGourichon, Benioku'nun yerel olarak görüntülenmesini düşünmemiştim. Sanırım göreceli bağlantılar isteniyorsa, bu kabul edilebilir bir sınırlama.

— jmar777

2

— Wiki'yi

3

Uyarı kelimesi: Bir README.mdkaydetme için a ve belirli bir blob gibi tek dosyaları görüntülerken , bu işe yaramaz.

— kaiser

Stephane Gourichon'un bahsettiği gibi, göreceli bağlantılar her zaman gidilecek yol değildir. Başka bir örnek, paketinizin üçüncü taraf bir açık kaynak platformu aracılığıyla kurulabilmesini istemenizdir. Python için bu PyPi'dir. PyPi açıklamada yüklenecek, ancak tüm ilgili bağlantılar kesilecektir. Bu durumda mutlak URL'lerle gitmeniz gerekir.

— cgnorthcutt

1

Sadece buna eklemek için, repo dosyanıza wiki kullanımı içinden başvurmak istiyorsanız ../../blob/master/ . Jmar777'nin cevabı ile birleştirildiğinde bu, kodu ve wiki'yi tamamen entegre etmeye ve şişirilmiş readme.md'ye olan ihtiyacı ortadan kaldırmaya izin verir.

Yerel olarak çalışmasını sağlamak için dosya yapınızın olması gerekir

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

— DfAC
kaynak

1

Jmar777'nin yaklaşımında tarif edildiği gibi 3 seviyeye karşı 2 seviyeye geri gitmem gerektiğini buldum.

Kullandığım zaman

../../wiki

Oluşturulan bağlantı https://github.com/<username>/blob/wiki

Kullanmam gerekiyordu:

../../../wiki

Bu üretti https://github.com/<username>/wiki

— Grendel
kaynak

1

GitLab kullanıyorum. Wiki sayfama olan bağlantım şöyle görünüyor.

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

Burada yayınlanan diğer önerileri denedim, ancak bağlantıyı kıran yeniden yazmalarla URL'yi değiştirmeye devam etti.

— LinuxGuru
kaynak