読者です 読者をやめる 読者になる 読者になる

Markdown 記法のチートシートを Vim の help として表示する(Gist, NeoBundle を使用)

Vim で Markdown の文書を書いているときに、「あれあの表現って Markdown ではどうやって出すんだっけ」と思うときが時たまある(取り消し線とか、めったに使わないもの)。こういうとき、いちいちネットを検索するのは非効率すぎるな〜と思っていた。せっかく Vim にはヘルプファイルがあるのだから、例えば :h markdown-cheat みたいなことをやってやればチートシートがテテーンと出てくればいいよね、と。

ちょっと調べてみたところ、僕が使っている NeoBundle というプラグインでは Gist から script type を指定してファイルをインストールすることができるようだった。公式にはこれが doc (ヘルプファイル)にも使えるとは書いてなかったので、ためしにやってみた。

さて、まずはヘルプファイルそれ自体を作らなければならないところだが、Gist を markdown jax で検索したところ、hail2u さんの gist を見つけたのでこれを使わせていただくことにした(ありがとうございます!)。

これさえあれば Gist を Vim のヘルプとするのは簡単で、NeoBundle の設定ファイルに以下のように書けば OK。ポイント(というほどでもないが)は script_typedoc を設定するところ。

NeoBundle 'gist:hail2u/747628', {
       \ 'name': 'markdown-cheat-sheet.jax',
       \ 'script_type': 'doc'}

これで再度 Vim を起動するとインストールの可否を聞かれるので、許可。するとあとは :h markdown-cheat-sheet とかって(補完とかを駆使しながら)やってやるとカンペが表示されるってワケ。やったぜ。