Jekyllで編集履歴リンクをつけてGitHubに飛ばす
世の中にはWeb上に公開した文書を”無断”で直すことを絶対に許さない人たちがいます。
そのせいで「削除」「[追記ここから]〜[追記ここまで]」みたいな変な文化もできています。
まるでバージョン管理がなかった時代のソースコードのような見づらさです。
そこで、有効なのが編集履歴の公開です。
履歴を公開していれば文句を言われる筋合いはないので、気軽に編集できるようになります。
で、本題。
Jekyll ＆ GitHub Pagesでサイトを公開している場合、編集履歴はすでにWeb上で公開されています。
あとはそこにリンクを貼ればいいわけです。
例えば、
http://spritekit.jp/matome/2013/10/11/japanese-sites/
から
https://github.com/tnantoka/spritekit.jp/commits/gh-pages/_posts/2013-10-11-japanese-sites.md
に飛ばしたいときどうすればいいか。
Jekyllのドキュメントを見ると、page.pathというまさしくその用途の変数がありました。
page.path
The path to the raw post or page. Example usage: Linking back to the page or post’s source on GitHub. This can be overridden in the YAML Front Matter.
早速、
_config.ymlに
|
1 |
repo_url: 'https://github.com/tnantoka/spritekit.jp' |
を追加して、
_layouts/post.htmlに、
|
1 |
<a href="{{ site.repo_url }}/commits/gh-pages/{{ page.path }}" target="_blank">編集履歴</a> |
と書いたらうまく動きました。
Jekyllをご利用中の方は是非。
最近のコメント