KOTET'S PERSONAL BLOG

#essay サイトの内容をGitHubのリポジトリと同期するメリット3つ

Created: , Last modified:
#essay #tech

これは1年以上前の記事です

ここに書かれている情報、見解は現在のものとは異なっている場合があります。

このようなツイートを見た。

これについて前から思っていた「GitHubのリポジトリの形で記事を公開するメリット」について書く。

今このサイトはGitHub Pagesを使い公開している。 なので必然的に記事のmarkdownはリポジトリ上にある。 GitHub Pagesを使わなくても、GitHub上の記事の変更が自サイトに反映される形にしておくと閲覧者と発表者双方にとっていいことがあると思う。 以下、そのメリットについて書き出していく。

1 - 誰でも更新履歴が見られる

個人サイトでも企業サイトでも、更新する前の内容を残しているところはあまり多くない。 他サイトの言及やスクリーンショットから、当時と現在ではサイトの内容が違うらしいということがわかる程度である。 しかし更新歴を見られるようにしておき、何が消されて何が書き足されたのかわかるようにしておくことで、閲覧者は歴史を踏まえて今の記事を見ることで混乱を防ぐことができる。 また、発表者は過去の内容に責任を持ち、残しておくことができる。

2 - 修正などを気軽に送ることができる

個人サイトでTypoを見つけても、そこでどこにTypoがあり、どう修正すべきかを文章にしてまとめてメールなどで送るのは送る側も受け取る側もかなりめんどくさい。 しかし記事をGitHubのリポジトリとして公開しておくとpull request機能を使い修正内容を簡潔に、Gitのdiffという統一された形式で送ることができる。 Qiitaの編集リクエストと互換である。

3 - 内容についての議論ができる

記事の内容に関わる大きな修正は、ただPRを送るだけではダメだろう。 その場合はissueを立てて、複数人で内容について議論できる。 これにより記事の感想などの普通のコメントと、内容についての議論を分けることができる。 さらに議論はその議題ごとに分割され保存される。 相互にリンクされた議論は後から確認して、記事の変遷をたどっていくこともできる。 このような議論はPR上でもできる。 Qiitaには編集リクエストについて議論する場は設けられていなかったはずなので、この点でQiitaの上位互換である。

以上のようにサイトをGitHubのリポジトリと連携させることにはメリットがある。 ポエムをQiitaに書けなくなって個人サイトを作る場合には、GitHubを活用することをお勧めしたい。