liên kết github đến trang wiki từ README

91

Làm cách nào để tạo liên kết từ tệp README.md đến trang Wiki trong github? Mọi ví dụ dường như hiển thị liên kết từ một trang wiki này đến một trang wiki khác, hoặc từ một tệp README đến một tệp khác trong kho lưu trữ. Nhưng không có cái nào hiển thị liên kết từ cái này đến cái kia

github

— veilig
nguồn

Bạn đúng. "từ một tệp README sang tệp khác trong kho lưu trữ" có hoạt động không, tài liệu tham khảo chính thức help.github.com/articles/relative-links-in-readmes blog chính thức github.com/blog/1395-relative-links-in-markup- các tệp , xem thêm bibwild.wordpress.com/2013/01/30/… .

— Stéphane Gourichon

Thông tin chi tiết về lý do tại sao liên kết từ README tới wiki không được mong muốn như vậy: "Chắc chắn, bạn có thể liên kết tới wiki của mình - nhưng wiki không được tạo phiên bản cùng với mã nguồn và bạn muốn liên kết đến phiên bản của tài liệu đi kèm ảnh chụp nhanh chính xác của repo nguồn mà bạn đang xem. Chắc chắn, bạn có thể liên kết ra bằng cách sử dụng siêu liên kết URL tuyệt đối - nhưng cùng một vấn đề, bạn luôn liên kết tới cái chính, khi bạn muốn liên kết đến tệp trong cùng một ảnh chụp nhanh, trình đọc đang xem README trong. " Nguồn: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

67

Bạn sẽ phải sử dụng URL tuyệt đối thay vì URL tương đối.

Ví dụ:

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

— tối đa
nguồn

4

ok, đó là những gì tôi nghĩ - chỉ muốn đảm bảo rằng không có cách nào tốt hơn.

— veilig

2

Trong tài liệu được liên kết bởi @ jmar777, nó cảnh báo về việc sử dụng URL tuyệt đối: "Người dùng sao chép kho lưu trữ của bạn sẽ gặp khó khăn hơn nhiều để các liên kết hoạt động hơn mong đợi."

— Dave Sexton

@DaveSexton Đó là đặc biệt đề cập đến liên kết đến các tệp khác trong kho lưu trữ (sẽ luôn liên quan đến README). Khi liên kết đến một cái gì đó bên ngoài (như wiki), bạn muốn sử dụng URL tuyệt đối.

— maxdeviant

92

Tôi mới xem qua câu hỏi này và thấy rằng điều này là không thể, nhưng dù sao vẫn cố gắng ngoan cố. Tin tốt, bởi vì điều này thực sự có thể được thực hiện với các liên kết tương đối!

Nếu bạn xem tài liệu về các liên kết tương đối trên GitHub , bạn có thể thấy rằng nó hỗ trợ ./và ../toán hạng.

Cho rằng README của bạn được đặt tại:

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

... và wiki được đặt tại:

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

... điều đó có nghĩa là bạn có thể thu thập dữ liệu từ README trở lại wiki, như sau:

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

Cập nhật: Như một số người đã chỉ ra trong các nhận xét (cảm ơn!), Xin lưu ý rằng các liên kết tương đối này sẽ bị hỏng trên các bản sao và bộ tách, vì vậy hãy cân nhắc điều đó vào quyết định của bạn!

— jmar777
nguồn

15

Thật thú vị, nhưng lưu ý rằng README.md có thể được xem từ một bản sao cục bộ thay vì web. Trong trường hợp đó, thứ duy nhất hoạt động là một liên kết có URL tuyệt đối.

— Stéphane Gourichon

1

Tốt, @ StéphaneGourichon, tôi đã không tính đến việc xem Readme tại địa phương. Mặc dù tôi cho rằng nếu các liên kết tương đối được mong muốn thì đó là một hạn chế có thể chấp nhận được.

— jmar777

2

Bạn có thể sao chép các wiki tại địa phương như một git riêng repo: stackoverflow.com/questions/15080848/...

— EriF89

3

Lời cảnh báo: Khi xem các tệp đơn lẻ như một README.mdvà một đốm cụ thể cho một cam kết, điều này sẽ không hoạt động.

— kaiser

Như Stephane Gourichon đã đề cập, các liên kết tương đối không phải lúc nào cũng là cách để đi. Một ví dụ khác là nếu bạn muốn gói của mình có thể cài đặt được thông qua nền tảng mã nguồn mở của bên thứ ba. Đối với Python, đây là PyPi. PyPi sẽ tải trong mô tả, nhưng tất cả các liên kết tương đối sẽ bị hỏng. Bạn cần sử dụng URL tuyệt đối trong trường hợp này.

— cgnorthcutt

1

Chỉ cần thêm vào cái này, nếu bạn muốn tham khảo tệp repo của bạn từ bên trong sử dụng wiki ../../blob/master/. Kết hợp với câu trả lời từ jmar777, điều này cho phép tích hợp hoàn toàn mã và wiki và loại bỏ nhu cầu về readme.md cồng kềnh.

Để làm cho nó hoạt động cục bộ cũng như cấu trúc tệp của bạn sẽ phải

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

— DfAC
nguồn

1

Tôi thấy rằng tôi cần phải thu thập dữ liệu trở lại 3 cấp so với 2 cấp như đã loại bỏ trong cách tiếp cận của jmar777.

Khi tôi sử dụng

../../wiki

Liên kết được tạo là https://github.com/<username>/blob/wiki

Tôi cần sử dụng:

../../../wiki

Điều này tạo ra https://github.com/<username>/wiki

— Grendel
nguồn

1

Tôi đang sử dụng GitLab. Liên kết đến trang Wiki của tôi trông như thế này.

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

Tôi đã thử các đề xuất khác được đăng ở đây nhưng nó tiếp tục thay đổi URL với các lần viết lại làm hỏng liên kết.

— LinuxGuru
nguồn