読者です 読者をやめる 読者になる 読者になる

gitバックエンドwiki.gollum

gitをバックエンドにしたwikiのgollumを試してみた.Sinatraで動いてるらしいです.

gollum/gollum · GitHub

f:id:programmerMOT:20140103035310p:plain

こんな感じの普通のwikiになります.この画面はある程度利用した姿です.

画面編集するといい感じに指定したリポジトリにコミットしてくれます.それをそのままpushもできます.

Install

$ gem install gollum
$ gem install github-markdown # markdownを利用可能にするため

いい感じにインストール完了すると思います.2つ目のは,一部記法の利用に必要なものです.README見るとわかると思います.

setting

あとはいい感じにディレクトリ用意して

$ mkdir wiki
$ cd wiki
$ git init
$ gollum --mathjax

mathjaxはmathjax記法を利用する感じのやつです.mathjaxはいい感じの数式記述のあれです.

特に指定しなければ実行した場所にデータを置いてリポジトリを更新するらしいです. 指定するには,--gollum-path使えばいい.

advance

フッターヘッダーサイドバー

_Footerと_Headerと_Sidebarという特殊なページを作るとフッターヘッダーサイドバーをいい感じにいじれるようになる.

ただいまいち使い勝手悪くて使ってない.

認証

オプションに--configというのがあっていい感じに書けるらしいです.sinatra分かる人にはわかるらしいですが,僕もちょっとしか知らないのでわかりません.

module Precious
  class App < Sinatra::Base
    use Rack::Auth::Basic, "Restricted Area" do |username, password|
      [username, password] == ['user', 'password']
    end
  end
end

このファイルをgollum起動時に--configつけて渡すとBasic認証になります.他の認証もRackたよればいい感じに書けるらしいです.

サーバに放置

あとはいい感じに起動スクリプト書いたりしてcrontabとかでwikiリポジトリを定期的にpull,pushすればバックアップも完璧.

gollum --helpでオプション出るので参考にして頑張ってください.

おわりに

便利な機能とか見つけたら教えてください.

参考文献

githubのwikiエンジン"gollum"の導入と細かい設定 - yukke::note