tautan github ke halaman wiki dari README

91

Bagaimana cara membuat link dari file README.md ke halaman Wiki di github? Setiap contoh tampaknya menunjukkan penautan dari satu halaman wiki ke halaman wiki lainnya, atau dari satu file README ke file lain dalam repositori. Namun tidak ada satupun yang menunjukkan keterkaitan satu sama lain

github

— kerudung
sumber

Kamu benar. "dari satu file README ke file lain dalam repositori" berfungsi, bantuan referensi resmi.github.com/articles/relative-links-in-readmes blog resmi github.com/blog/1395-relative-links-in-markup- file , lihat juga bibwild.wordpress.com/2013/01/30/… .

— Stéphane Gourichon

Wawasan tentang mengapa tautan dari README ke wiki tidak begitu diinginkan: "Tentu, Anda dapat menautkan ke wiki Anda - tetapi wiki tidak memiliki versi bersama dengan kode sumber, dan Anda ingin menautkan ke versi dokumen yang menyertai snapshot tepat dari repo sumber yang Anda lihat. Tentu, Anda dapat menautkan menggunakan hyperlink URL absolut - tetapi masalah yang sama, Anda selalu menautkan ke master, saat Anda ingin menautkan ke file dalam snapshot yang sama dengan pembaca sedang melihat README di. " Sumber: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

67

Anda harus menggunakan URL mutlak sebagai lawan yang relatif.

Sebagai contoh:

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

— maxdeviant.dll
sumber

4

ok, itulah yang saya pikirkan - hanya ingin memastikan tidak ada cara yang lebih baik.

— kerudung

2

Dalam dokumen yang ditautkan oleh @ jmar777, ini memperingatkan tentang penggunaan URL absolut: "Pengguna yang mengkloning repositori Anda akan lebih sulit mendapatkan tautan untuk berfungsi daripada yang diharapkan."

— Dave Sexton

@DaveSexton Itu secara khusus mengacu pada penautan ke file lain dalam repositori (yang akan selalu berhubungan dengan README). Saat menautkan ke sesuatu yang eksternal (seperti wiki), Anda ingin menggunakan URL absolut.

— maxdeviant

92

Saya baru saja menemukan pertanyaan ini dan melihat bahwa ini tidak mungkin, tetapi dengan keras kepala tetap berusaha. Kabar baik, karena ini sebenarnya bisa dilakukan dengan tautan relatif!

Jika Anda melihat dokumentasi untuk tautan relatif di GitHub , Anda dapat melihat bahwa ia mendukung ./dan ../operand.

Mengingat README Anda berada di:

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

... dan wiki terletak di:

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

... itu berarti Anda dapat merayapi kembali dari README ke wiki, seperti:

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

Pembaruan: Seperti yang ditunjukkan beberapa orang di komentar (terima kasih!), Perlu diketahui bahwa tautan relatif ini akan merusak klon dan garpu, jadi pastikan untuk mempertimbangkannya dalam keputusan Anda!

— jmar777
sumber

15

Menarik, tetapi perhatikan bahwa README.md dapat dilihat dari tiruan lokal, bukan dari web. Dalam hal ini, satu-satunya yang berfungsi adalah tautan dengan URL absolut.

— Stéphane Gourichon

1

Poin bagus, @ StéphaneGourichon, saya belum mempertimbangkan tontonan lokal Readme. Meskipun saya kira jika tautan relatif diinginkan, itu adalah batasan yang dapat diterima.

— jmar777

2

Anda dapat mengkloning wiki secara lokal sebagai repo git terpisah: stackoverflow.com/questions/15080848/…

— EriF89

3

Kata peringatan: Saat melihat file tunggal seperti a README.mddan blob tertentu untuk komit, ini tidak akan berfungsi.

— kaiser

Seperti yang disebutkan oleh Stephane Gourichon, tautan relatif tidak selalu menjadi cara yang tepat. Contoh lainnya adalah jika Anda ingin paket Anda dapat diinstal melalui platform sumber terbuka pihak ketiga. Untuk Python, ini adalah PyPi. PyPi akan dimuat dalam deskripsi, tetapi semua tautan relatif akan rusak. Anda harus menggunakan URL absolut dalam kasus ini.

— cgnorthcutt

1

Untuk menambahkan yang satu ini, jika Anda ingin merujuk ke file repo Anda dari dalam gunakan wiki ../../blob/master/. Dikombinasikan dengan jawaban dari jmar777 ini memungkinkan untuk sepenuhnya mengintegrasikan kode dan wiki dan menghilangkan kebutuhan readme.md yang membengkak.

Untuk membuatnya bekerja secara lokal serta struktur file Anda harus

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

— DfAC
sumber

1

Saya menemukan bahwa saya perlu merangkak kembali 3 level versus 2 level seperti yang dijelaskan dalam pendekatan jmar777.

Saat saya digunakan

../../wiki

Tautan yang dihasilkan adalah https://github.com/<username>/blob/wiki

Saya perlu menggunakan:

../../../wiki

Ini menghasilkan https://github.com/<username>/wiki

— Grendel
sumber

1

Saya menggunakan GitLab. Tautan saya ke halaman Wiki saya terlihat seperti ini.

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

Saya mencoba rekomendasi lain yang diposting di sini tetapi terus mengubah URL dengan menulis ulang yang merusak tautan.

— LinuxGuru
sumber