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

ぼろぼろ平原

困った

ぼっちWikiに最適なGollumについてのメモ

自分だけが使うぼっちWikiGollumで作成したときのメモ。

GollumはデータベースにGitを使い、Markdownで書けるWiki

Gollumの特徴は以下の通り。

  • シンタックスハイライト数式に対応している
  • 様々な記法で書ける
  • gemコマンドで簡単にインストールできる
  • データベースとしてGitを使うのでMySQLなどが不要
  • RubySinatraで実装されている
  • Rubyでマクロを書いて拡張できる

欠点は、日本語の扱いに気をつける必要があること(後述)。

Gollumのインストール

ICUという文字コード変換ライブラリに依存しているのでまずはそれをインストール。

# OS Xの場合
$ brew install icu4c

# Debian/Ubuntuの場合
$ sudo apt-get install libicu-dev

続いて、Gollum本体をインストール。

$ gem install github-markdown gollum

日本語の扱いについて

ページのタイトルに漢字を使うと、URLがピンイン(中国語のローマ字のようなもの)になってしまう。 タイトルは適当に英語で入力し、真の日本語タイトルは本文中でMarkdownの#を使って書けば問題ない。

認証の設定

ぼっちWikiなので、他人に内容を見られてしまっては困る。

Gollumは普通のSinatraアプリと同じように、ユーザー認証をつけることができる。

こんな感じのauth.rbを作成。

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

Basic認証&ファイルにパスワード直書きなので、盗聴やパスワード漏洩の可能性がある。あくまでも気休め。

Gollumの起動

$ git init # 初回だけ
$ gollum --mathjax --config auth.rb --allow-uploads