アトトックラボ

2011年10月20日

VimWiki を導入する

Posted by Nobuyuki Sato

今回も MacVim 中毒のサトウがお送りします。今回は MacVim に VimWiki を組み込んで活用しようというお話です。

VimWiki とは何か?

VimWiki とはその名前が示すとおり、Vim を Wiki としても使ってしまおうというプラグイン。テキストベースの Wiki として機能する上に、シンタックスでカラー表示されるので、日常的にエディタは Vim を使っている僕からすると、非常に便利なわけです。

インストール

Google Code に専用のページがあります。最新版をダウンロードします。zip で圧縮されているファイルを解凍すると、vimwiki.vba となっているので、このファイルを開いて、

:source %

とすればインストール完了です。
<Leader>ww で最初の自分のローカルな Vim 上で走る Wiki を立ち上げてみましょう。

簡単な Wiki 記法

Wiki 記法は単純なものしかサポートされていませんが、過不足ありません。

見出し

= 文字列 =
== 文字列 ==
=== 文字列 ===
==== 文字列 ====

こんな感じにすると、見出しとして定義されます。

リスト

* 文字列
- 文字列

アスタリスク or ハイフン + スペースを行の先頭に入れればリストとなります。

リンク

[[文字列]] とすれば、"文字列" で指定したページを作成して、そのままリンクにすることができます。

HTMLにも出力可能

僕は Vim 上でしか使っていませんが、Wiki を HTML に出力することもできます。

:VimwikiAll2HTML

で、全ての Wiki ページを HTML に、

:Vimwiki2HTML

で、編集中のファイルを HTML に出力できます。

一時期、changelog のフォーマットを活用する、なんてことが流行りましたが、Vimwiki を活用するとテキストエディタである Vim だけでかなりの情報を管理することができるようになります。活用してみてはいかがですか?