READMEからwikiページへのgithubリンク

91

README.mdファイルからgithubのWikiページへのリンクを作成するにはどうすればよいですか？すべての例は、ある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ハイパーリンクを使用してリンクアウトすることもできますが、同じ問題として、リーダーと同じスナップショット内のファイルにリンクする場合は、常にマスターにリンクしています。でREADMEを見ています。」出典：bibwild.wordpress.com/2013/01/30/...

— ステフェイン・グーリッホン

67

相対URLではなく絶対URLを使用する必要があります。

例えば：

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

— maxdeviant
ソース

4

わかりました、それは私が思ったことです-ただより良い方法がないことを確認したかっただけです。

— veilig 2014年

2

@ jmar777によってリンクされているドキュメントでは、絶対URLの使用について警告しています。「リポジトリのクローンを作成するユーザーは、リンクを機能させるのに予想以上に苦労します。」

— デイブ・セックストン2016年

@DaveSextonこれは、リポジトリ内の他のファイルへのリンクを具体的に指します（これは常にREADMEに関連しています）。外部のもの（ウィキなど）にリンクするときは、絶対URLを使用する必要があります。

— maxdeviant 2017

92

私はちょうどこの質問に出くわし、これが不可能であることに気づきましたが、とにかく頑固に試み続けました。これは実際には相対リンクで実行できるため、朗報です。

GitHubの相対リンクのドキュメントを見ると、GitHubがサポート./と../オペランドをサポートしていることがわかります。

READMEが次の場所にあると仮定します。

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

...そしてwikiは次の場所にあります：

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

...つまり、次のように、READMEからwikiに戻ることができます。

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

更新：コメントで指摘されている人もいますが（ありがとう！）、これらの相対リンクはクローンとフォークで壊れることに注意してください。それを決定に考慮してください。

— jmar777
ソース

15

興味深いですが、README.mdはWebではなくローカルクローンから表示される場合があることに注意してください。その場合、機能するのは絶対URLのリンクだけです。

— ステフェイン・グーリッホン

1

良い点、@StéphaneGourichon、Readmeのローカル表示については考慮していませんでした。相対リンクが必要な場合は許容できる制限だと思いますが。

— jmar777 2015年

2

あなたは別のGitのレポとしてローカルのwikiのクローンを作成することができますstackoverflow.com/questions/15080848/...

— EriF89

3

警告の言葉：README.mdコミットの特定のblobのような単一のファイルを表示する場合、これは機能しません。

— カイザー2016

Stephane Gourichonが述べたように、相対的なリンクが常に役立つとは限りません。もう1つの例は、サードパーティのオープンソースプラットフォームを介してパッケージをインストールできるようにする場合です。Pythonの場合、これはPyPiです。PyPiは説明に読み込まれますが、すべての相対リンクが切断されます。この場合、絶対URLを使用する必要があります。

— cgnorthcutt

1

wiki内からリポジトリファイルを参照したい場合は、これを追加するだけ../../blob/master/です。jmar777からの回答と組み合わせると、コードとwikiを完全に統合し、肥大化したreadme.mdの必要性を排除できます。

それをローカルで機能させるには、ファイル構造は次のようにする必要があります

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

— DfAC
ソース

1

jmar777のアプローチで説明されているように、2レベルではなく3レベルをクロールバックする必要があることがわかりました。

使った時

../../wiki

生成されたリンクは https://github.com/<username>/blob/wiki

私は使用する必要がありました：

../../../wiki

これは生成されました https://github.com/<username>/wiki

— グレンデル
ソース

1

私はGitLabを使用しています。Wikiページへのリンクは次のようになります。

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

ここに掲載されている他の推奨事項を試しましたが、リンクを壊すような書き直しでURLを変更し続けました。

— LinuxGuru
ソース