このページは

個人用wiki

個人用wikiとして

Gollumの特徴

  • かなりシンプルなwikiでGit baseでmarkdownのwiki
  • Git操作ができる事が割と前提
    • 非エンジニア用wikiにはなりにくい
    • この記事では一人運用前提で話します
  • Gitリポジトリでファイルを管理する
    • wikiの階層構造 = リポジトリ内のディレクトリの階層構造
    • データベースでなく只のファイルなので,移植もしやすく可塑性に富む
    • wikiのページ = 1ファイルなので,お好きなエディタでゴリゴリ書いていける
      • 長文書く時に,結構嬉しい
  • Git commitで変更が反映される仕様
    • Web上でも変更可能(Web上の変更 = add & commit)
  • Markdownで書ける
    • プラグイン的なのを入れるとMediawiki文法も書ける
  • 数式はLaTeXっぽく書ける
    • mathjaxで本家LaTeXと微妙に文法が違う
  • その気になってrailsを書けば拡張可能
    • あんまり日本語記事は少ない印象,拡張する時は英語で調べないと基本でてこない
    • 一応configあたりでrailsの関数をゴニョっと書くとなんとかなる(白目)
  • サーバー立てる以外にも,PCごとにgollumをインストールして,Gitリポジトリだけリモートに置いておくという方式も取れる
    • サーバーよく分からなくてもwikiを立てられる
    • Backupはリモートリポジトリが兼ねる

環境構築

install

  • Windowsでも建てられるっぽいけど,バグバグしいかもしれない・・・?(情報求む)

  • install

sudo apt-get install gem ruby-dev
sudo gem install gollum 
sudo gem install github-markdown
  • mediawiki文法で書きたい人は
sudo gem install wikicloth 

wikiを立てる

  • cd ~
  • mkdir wiki
    • お好きなところに
  • git init
  • vim Home.md or vim Home.mediawiki
    • なんか書く
    • お好きなエディタでどうぞ
  • git add -A
  • git commit -m “update”
  • gollumを起動する gollum –allow-uploads –show-all –mathjax
    • それぞれのオプションの意味はreadme参照
    • Markdownしか使わない人は gollum –allow-uploads –show-all –mathjax –live-previewしたほうがいいかも
  • .bashrcとか.zshrcとかで適当にaliasしておくと便利
  • ブラウザでlocalhostアクセスすると見れる
    • http://localhost:4567/Home
    • デフォルトポートは4567

基本的な運用

  • wikiディレクトリ下に階層を作る,以下は例
wiki/
 ├ study/
 ├ tech/
 ├ hobby/
 └ uploads/

ページ作成

  • vim hoge.md
    • ファイル = ページを作る
    • ブラウザからも作成可能だけど,階層構造の中に入ってくれないのでlocalのエディタで作る
    • 拡張子は.md
      • mediawiki拡張してある場合は.mediawiki
  • git add -A
  • git commit -m “update”

ファイル編集

  • ファイル直接編集
    • vim 直したいファイル.md
    • git add -A
    • git commit -m “update”
  • もしくはブラウザ上のEditボタン押せば編集画面になる

ページ内リンクについて

  • [[ページ名]]
    • [[hoge]]
    • リポジトリ内全部からアクセスできるはず
    • 基本的にページ名被りはさせないように
  • [[/hobby/fuga]]
    • 頭に/をつけると絶対パスになる
    • rootは.gitが有る場所

ファイルのアップロード

  • /uploadsにpngやらpdfやらを置く
  • git add -A && git commit -m “update”
  • リンクを書く
    • pdfの場合 [[名前 | /uploads/hoge.pdf]]
    • pngの場合 [[/uploads/hoge.png]]
    • mp4の場合 [[/uploads/hoge.mp4]]

数式

$ \frac{x}{y} $
  • $ \frac{x}{y} $
    • 文中に埋め込む
$$ \frac{x}{y} $$
  • $$ \frac{x}{y} $$
    • 中央揃えになる

サイドバー

  • _Sidebar.mdでサイドバーが作成できる
  • よく使うページを書いておくと便利

.gitignore

  • git baseなので.gitignoreが使える
    • wikiのリポジトリでもうまく使いこなすと便利