vimでmarkdown記法を快適に
githubでも取り入れられているmarkdown記法ですが、会社でちょっとしたメモをこの記法で書いてみたところ書きやすい上に読みやすくていいなぁ、と思いました。
ということで、vimでmarkdownを快適に書く環境を整えました。
blueclothのインストール
$ gem install bluecloth
BlueClothは別のgem(バージョン違い?)なので小文字で打ってください。
とりあえずコマンドラインでmarkdownからHTMLに
こんなコマンドでOKです。
$ bluecloth -f test.md
-fオプションを付けないとひとつのファイルとして<html>やら<head>タグやらから出力されてしまいます。
vimで便利に書けるようにしよう
シンタックスハイライトと、変換後のHTMLのプレビューができれば便利ですよね。
vim-markdownとvim-quickrunでできます。
vim-markdownのインストール
僕はvimのプラグインをpathogenを使い、gitで管理しているため、以下のコマンドで簡単インストールでした。
$ git submodule add https://github.com/tpope/vim-markdown.git .vim/bundle/vim-markdown
特に設定もいらず、これで*.mdやら、*.markdownやらの拡張子のファイルがシンタックスハイライトされるようになります。
追記:最新版のVimでは標準でmarkdownのシンタックスハイライトができるそうです。
調べてみたところ、/usr/share/vim以下にはmarkdown.vimがありませんでしたが、MacVim.appの中にはありました。(@thincaさん、ありがとうございます。)
vim-quickrunの設定
vim-quickrunのインストールは済んでいると仮定します。(ruby使ってrspecやったりする人はきっとみんな済んでる) .vimrcに以下のような設定を足すことで、<Leader>rでHTMLへの変換結果を見ることができます。
let g:quickrun_config = {}
let g:quickrun_config['markdown'] = {
\ 'command': 'bluecloth',
\ 'exec': '%c -f %s'
\ }
追記:vim-quickrunにデフォルトでmarkdownの設定が入りました。今後は上記の設定を行わなくとも、HTMLに変換できます。
参考サイト
- Markdown文法の全訳
markdown記法の解説が和訳されています。