GitHubにはバージョン管理したい文書とは別で、Wikiによるコンテンツ管理機能が提供されています。Markdownをはじめとして各種記法を使って書けるので、手軽なCMSとして使っている人も多いのではないでしょうか。 このエディタはタブを切り替えて編集とプレビューを確認します。多くのエディタで実装されている左右表示でのリアルタイムプレビューが良い方はGitHub Wiki Live Editを使ってみましょう。

GitHub Wiki Live Editの使い方

GitHub Wiki Live Editが適用されていない場合です。

導入後。左右に分かれて表示されています。

ついでに各種記法のヘルプが追加されています。なお、入力する度に反映される訳ではなく、若干のタイムラグがあります。実際にGitHubでコールしているからでしょう。

記法に慣れた人であればそんなに気にせず文書を書き進められるかも知れませんが、そうでないとプレビューを見て正しく書けているか確認することでしょう。さらに記法のチートシートがあると手軽に書けるようになります。特に初学者に優しいソフトウェアと言えそうです。

GitHub Wiki Live EditはGoogle Chrome機能拡張のオープンソース・ソフトウェア(MIT License)です。

yuya/github-wiki-live-edit: Adding live editing features into Github wiki.