vim-jp » Hack #38: vimwikiで文章を管理する

Hack #38: vimwikiで文章を管理する

Posted at 2009/07/08

Wikiという文章の作成・編集を行うツールがあります。基本的にはサービスとして公開されているものを使う、自分でWikiのプログラムをどこかのサーバ(もしくはローカル環境)に起動させてあるものを使用します。

複数人での管理という点においてはWeb上にあるのは非常に便利です。しかし、あくまで個人のメモツールとして考えた場合、一々ネットに接続しなければならない点や、Webブラウザからの文章入力は非常につらいなどと言った問題点があります。

vimwikiはVim Scriptで動作するWikiで、普段からVimを使っている人であればいつものテキスト編集と同じ形で文章を管理することが出来ます。

上記URLからvimballをダウンロードします。その後、Vimでそのファイルを開き、:source %を実行し、インストールは完了です。

Vimを起動し、\wwと入力するとWikiの一番トップにあたるページが開きます。ページがない場合は自動的に作られます。他のページを開いてるときにトップに移動したい場合にも\wwと入力します。

Wikiですので基本的にはトップからツリー上にページを作っていくと思います。ページを作るときはまずそのページへのリンクを作り、そのページに移動するという形で作ります。

リンクの作りかたはキャメルケースで書くかもしくは[[]]で囲んだ文字列がリンクになります。

NewPage
[[new_page]]

気をつけなくてはならないのが、このリンク名がファイル名になることです。基本的には日本語やスペース、/などは使わない方がいいでしょう。HTMLファイルを生成した時などにリンクがつながらないなどの問題が起きます。

wikiのページの移動はリンクの上でEnterを押すとそのページに、BackSpaceを押すと1つ前のページに戻ります。

リンク以外にも見出しやリスト、テーブルなどあります。詳細は:help vimwiki-syntaxを見てください。

vimwikiには書いた文章をHTMLに変換する機能があります。:Vimwiki2HTMLか:VimwikiALL2HTMLのどちらかを使用してください。単体ページのみの変換か全てのページを変換するかの違いです。

生成されたHTMLファイルは$HOME/vimwiki_html/index.htmlといった感じに生成されます。

筆者はブログに書くネタや、カンファレンス、勉強会などのメモをvimwikiで管理しています。適当なディレクトリにメモを書いたテキストファイルを放りこんでもいいのですが、なんとなくWikiを使うと整理がしやすい気がします。

ukstudio