Vim で GitHub Flavored Markdown をプレビューする

13/09/28 23:13 設定の記述を誤っていたため修正しました。 339d483

検索して見つかる Vim で Markdown をプレビューする方法は、どれも GitHub Flavored Markdown に対応しておらず GitHub で改めて確認すると表示が崩れていることが多々ありました。そんな悲劇をなくすため GitHub Markdown Rendering API を使ってプレビューする vim-quickrun-markdown-gfm を作りました。

https://github.com/superbrothers/vim-quickrun-markdown-gfm

以下の利点があります。

• GitHub Flavored Markdown でプレビューできる
• Perl, Ruby などの Markdown parser に依存していない
• 別途プレビューサーバを起動する必要がない

vim-quickrun はデフォルトで markdown のプレビューに対応していますが、redcarpet に依存したくなかったり、コードブロックが GitHub Flavored Markdown に対応していないため、vim-quickrun-markdown-gfm では GitHub Markdown Rendering API を使っています。またプレビューを GitHub で閲覧した際と同じにするために revolunet/sublimetext-markdown-preview の CSS を使わせてもらっています。

インストール (Vundle)

.vimrc に下記を追記します。

Bundle 'thinca/vim-quickrun'
Bundle 'mattn/webapi-vim'
Bundle 'tyru/open-browser.vim'
Bundle 'superbrothers/vim-quickrun-markdown-gfm'

let g:quickrun_config = {
\   'markdown': {
\     'type': 'markdown/gfm',
\     'outputter': 'browser'
\   }
\ }

その後 :BundleInstall を実行します。

GitHub Enterprise の API を利用したい場合は、下記を追記してください。

let g:quickrun_markdown_gfm_github_api_url = 'https://<your-github-enterprise-hostname>/api/v3'

使い方

:QuickRun markdown

詳しくは vim-quickrun のヘルプを確認してください。

:h quickrun