Githubでも使える、Git管理のWikiエンジン「Gollum」
GollumはRuby製のオープンソース・ソフトウェア。最近のWikiエンジンであれば大抵コンテンツの履歴管理機能がついている。独自に実装されることも多いが、手軽に実装するならば既に存在するSCMを利用する方が良いだろう。例えばGitは良い選択肢になる。
表示画面
話は変わりGithubではReadmeファイルなどを配置すると自動的に内容をプロジェクトトップページに配置してくれる機能がある。テキストフォーマットはMarkdownやRDoc、Textileなどが利用できる。この二つを組み合わせたのがGollumだ。
GollumはGitリポジトリ内で使うWikiエンジンだ。Gollumコマンドを実行すると、ポート番号4567でWebサーバが立ち上がる。そしてコンテンツを自由に作成できる。コンテンツは保存を実行するごとにGitリポジトリに追加されるようになっている。
拡張子を追加してアクセスすると、各フォーマットで文書が取り出せる
同時にページ名.(拡張子)というファイルが作成される。拡張子はWikiコンテンツを作成するのに使った記法による。使えるのはASCIIDoc、Creole、Markdown、Org-mode、Pod、RDoc、ReStructuredText、Textileとなっている。
Wikiエンジンとしては、簡単な文字装飾や画像埋め込み、リンク作成、リスト作成といった記法が簡単に入力できるようになっている。Githubとの組み合わせはもちろんプロジェクト用ドキュメントを作成するのにも十分使える便利なソフトウェアだ。
編集中の画面
github’s gollum at master - GitHub