github посилання на вікі-сторінку з README

91

Як створити посилання з файлу README.md на сторінку Wiki у github? Здається, кожен приклад показує посилання з однієї сторінки wiki на іншу сторінку wiki або з одного файлу README на інший файл у сховищі. Але жодного, що демонструє зв'язок від одного до іншого

github

— veilig
джерело

Ти маєш рацію. "з одного файлу README на інший файл у сховищі" працює, офіційний посилання help.github.com/articles/relative-links-in-readmes офіційний блог github.com/blog/1395-relative-links-in-markup- файли , див. також bibwild.wordpress.com/2013/01/30/… .

— Стефан Гурішон

Поглиблене розуміння того, чому посилання з README на wiki не таке бажане: "Звичайно, ви можете зробити посилання на свою wiki - але wiki не має версій разом із вихідним кодом, і ви хочете зробити посилання на версію документів, яка йде разом з точний знімок вихідного репо-файлу, який ви переглядаєте. Звичайно, ви могли б зробити посилання за допомогою гіперпосилань за абсолютними URL-адресами - але та сама проблема, ви завжди посилаєтесь на master, коли ви хочете зробити посилання на файл у тому ж знімку зчитувача дивиться на README у ". Джерело: bibwild.wordpress.com/2013/01/30/…

— Стефан Гурішон 02.03.15

67

Вам доведеться використовувати абсолютну URL-адресу на відміну від відносної.

Наприклад:

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

— maxdeviant
джерело

4

добре, ось що я думав - просто хотів переконатись, що не було кращого шляху.

— veilig

2

У документі, на який посилається @ jmar777, він застерігає щодо використання абсолютних URL-адрес: "Користувачам, які клонують ваше сховище, буде набагато складніше змусити посилання працювати, ніж очікувалося".

— Дейв Секстон,

@DaveSexton Це конкретно стосується посилання на інші файли у сховищі (яке завжди буде відносно README). Посилаючись на щось зовнішнє (наприклад, на вікі), ви хочете використовувати абсолютні URL-адреси.

— maxdeviant

92

Я просто натрапив на це запитання і побачив, що це неможливо, але все одно вперто намагався намагатися. Хороші новини, адже насправді це можна зробити за допомогою відносних посилань!

Якщо ви подивитесь на документацію щодо відносних посилань на GitHub , то побачите, що вона підтримує./ та../ операнди.

Враховуючи, що ваш README знаходиться за адресою:

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

... а вікі знаходиться за адресою:

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

... це означає, що ви можете просто переповзти назад із README у вікі, приблизно так:

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

Оновлення: Як деякі люди зазначали у коментарях (спасибі!), Майте на увазі, що ці відносні посилання порвуться на клонах та виделках, тому обов’язково зважте це на своє рішення!

— jmar777
джерело

15

Цікаво, але зауважте, що README.md можна переглядати з локального клону замість Інтернету. У цьому випадку єдине, що працює, це посилання з абсолютною URL-адресою.

— Стефан Гурішон

1

Хороший момент, @ StéphaneGourichon, я не розглядав можливість місцевого перегляду Readme. Хоча я вважаю, що якщо бажані відносні посилання, це прийнятне обмеження.

— jmar777 02.03.15

2

Ви можете клонувати вікі локально , як окремий мерзотник репо: stackoverflow.com/questions/15080848 / ...

— EriF89

3

Слово попередження: під час перегляду окремих файлів, таких як a README.mdта певна велика кількість для коміту, це не буде працювати.

— kaiser

Як згадував Стефан Гурішон, відносні посилання не завжди є шляхом. Інший приклад - якщо ви хочете, щоб ваш пакет встановлювався через незалежну платформу з відкритим кодом. Для Python це PyPi. PyPi завантажується в описі, але всі відносні посилання будуть порушені. У цьому випадку вам потрібно вказати абсолютні URL-адреси.

— cgnorthcutt

1

Просто додайте цей, якщо ви хочете звернутися до свого файлу репо з використання всередині wiki ../../blob/master/ . У поєднанні з відповіддю з jmar777 це дозволяє повністю інтегрувати код та вікі та усунути потребу в роздутому readme.md.

Щоб це працювало локально, а також повинна бути ваша структура файлів

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

— DfAC
джерело

1

Я виявив, що мені потрібно просканувати назад 3 рівнів проти 2 рівнів, як описано у підході jmar777.

Коли я використовував

../../wiki

Створене посилання було https://github.com/<username>/blob/wiki

Мені потрібно було використовувати:

../../../wiki

Це генерується https://github.com/<username>/wiki

— Грендель
джерело

1

Я використовую GitLab. Моє посилання на мою сторінку Вікі виглядає так.

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

Я спробував інші рекомендації, які розміщені тут, але він продовжував змінювати URL-адресу з повторними записами, які порушили посилання.

— LinuxGuru
джерело