Hack #52: Markdown形式の文書を書く

問題

HTMLやTeXを直接書かずに、より人間にとって読み書きしやすい他の高水準マークアップ言語を用いて記述することがあります。 Markdownはその一つで、広く一般に使われています。

Markdown形式の文書をVimで容易に取り扱うためには、

1. 構文ハイライト
2. コンパイル結果を容易に確認できること

が望まれます。

解決

Vimは標準ではMarkdown形式のシンタックスハイライトを提供していません。 以下のURLからmkd.vimを取得し、~/.vim/syntax/以下に配置しましょう。

mkd.vim http://www.vim.org/scripts/script.php?script_id=1242

次に、拡張子.mkdまたは.mdファイルをMarkdownに関連づけます。 ~/.vim/ftdetect/mkd.vimというファイルを作り、以下の二行を記述します。

autocmd BufRead,BufNewFile *.mkd  setfiletype mkd
autocmd BufRead,BufNewFile *.md  setfiletype mkd

これでMarkdown形式の文書を執筆時、以下のようにハイライトされ、 構文に誤りがある場合などすぐに分かるようになります。

さらに、実際にMarkdown形式の文書をHTMLに変換してブラウザで確認しましょう。 幸いにもquickrun.vimがMarkdown形式に対応しているため、これを用いてみましょう。 (quickrun.vimについては [Hack #7: 編集中ファイルを実行し、結果を表示したままにする] を参照ください)

quickrun.vimがインストールされているVimでMarkdown文書を編集中に\rなどのキーでquickrunを呼び出すと、即座に編集中ファイルをHTMLに変換し、ブラウザで開きます。

事前にpandocをインストールする必要があります。pandocはHaskellで記述されたMarkdown文書などの変換ツールで、MacPortsやCabalなどで容易にインストールすることができます。

議論

2009-08-05現在、mkd.vimには数多くのバグがあるようで、よくシンタックスハイライトが狂います。発見し次第、mkd.vimにパッチを書いて本家に投稿すると良いでしょう。

なお、著者は本Vim Hacksの記事自体をMarkdownの拡張文法であるmdv (Markdown for Vim Hacks)を用いて記述されています。

ujihisa