Githubの.mdファイルで文書間リンクを貼るときは相対パス指定しましょう

Githubでレポジトリを作って.mdファイルベースでドキュメント管理する場合、文書間のリンクで相対パス指定ができます。

これを知らずに絶対パスを書いてしまってるケースが非常に多いです。
身の回りでみかけたら教えてあげましょう。

どういうこと?

例えば、
https://github.com/DQNEO/memo
というレポジトリがあったとして、
README.md から AboutMe.md にリンクを貼りたいとします。

このときREADME.mdにリンクを書くわけですが、やり方が2つあります。
絶対パス指定
[AboutMe](https://github.com/DQNEO/memo/blob/master/AboutMe.md)
相対パス指定
[AboutMe](/AboutMe.md)

絶対パスで書いたらなぜダメなのか

ウェブサイトを運営したことがある人ならすぐわかるかと思います。
  • レポジトリの名前が変わったとき
  • forkして所有者の名前が変わったとき
に、URLを全部書きなおさないといけなくなります。

よいみほん

https://github.com/DQNEO/memo/blob/master/README.md
相対パスの方が短いし、これを使わない手はないでしょう。
カテゴリ:

人気記事