vimでマークダウンファイルをリアルタイムプレビューする

これまで使っていたマークダウン関連のプラグインが何故か動作しなくなっていて、原因探るのも面倒くさかったので、何か新しいプラグインとか開発している人がいるんじゃないか、と思って探したら、いました。

github.com

starもいっぱい付いてるし、READMEも充実してるし、ということで試してみました。

インストール

プラグインの管理にはvim-plugを使っているので、設定ファイルに以下の記述を追加して、:PlugInstallします。

" markdown plugin
Plug 'iamcco/markdown-preview.nvim', { 'for': ['markdown'], 'do': 'cd app & yarn install'  }

注意事項

公式サイトにはインストール方法が２つ紹介されていて、１つは以下の記述。

Plug 'iamcco/markdown-preview.nvim', { 'do': { -> mkdp#util#install() } }

こちらの方法だと自分の環境ではインストールに失敗しました。原因は不明。

仕方がないので上記のyarn installの手法でのインストールにしたところ、うまく動作するようになりました。
もちろん、こちらは予め、nodejs環境とyarnがインストールされていることが前提となります。

使い方

テキトーなマークダウンファイルを開いて編集後、:MarkdownPreviewコマンドを叩きます。
ブラウザのタブが開いてプレビュー開始。
毎回、MarkdownPreviewを打ち込むのはツライので、ノーマルモードで;;pと打ち込むとプレビューを開始するようにしました。

" ---------------
" markdown-preview.vim setting
" ---------------
nnoremap <silent> ;;p :MarkdownPreview<CR> " ;;pでプレビュー

感想

編集位置に合わせてスクロールも追随してくれるし、GitHub Flavored Markdownのテーブル記法などにも対応していて、機能としては十分だと思いました。

試していませんがmermaid記法とか（試しました）、そのあたりの記法にもしっかり対応しているようで、starがたくさん付いてるのもうなづけます。

動作としては特にこれまで使っていたプラグインとは特に差はないんですが、プラグインだけインストールすれば、とりあえず動作する、とか導入が簡単なのは良いな、と思いました。