vimのhelpを書きたい

前回vim プラグインを作成するということでhello worldを書きました。
初めて使う人用にこちらにhelpを追加したいと思います。
自分でhelpを書くときはどのように作成すればいいのかわからないので調べてみました。
vim上で :help helpと起動するとhelpのhelpを参照できます。興味がある方は確認してみてください。
(https://github.com/vim/vim/blob/master/runtime/doc/helphelp.txt)

help fileの書き方

pluginにdocディレクトリーを追加します。
コマンドを入力しておきます。

 :set tw=78
 :set ts=8
 :set ft=help

helpの体裁

helpの見た目を整えるため、体裁を決めます。
vimは2行開けた後helpファイルが読み込まれます。70行または80行として表示されます。
helpを開いたときに設定させるために行末にhelpの体裁を記入しておきます。
vim:tw=78:ts=8:noet:ft=help:norl:

1行目

1行目にプラグイン名を記載します。vimから:help plugin_nameで呼び出せるようになります。
*plugin_name.txt* <短いpluginの説明>

リンクの作り方。

ジャンプするには(ctrl+クリック),(CTRL-])を押す。
ctrl-O ,ctrl-T戻る

tagを作成するには、アスタリスクで作成する。 (*tag-name*)
バーを追加するとホットリンクが作成できタグにジャンプ出来る。(|tag-name|に戻る)
シングルクォートでvimのオプションにジャンプする。('option')

ハイライト

tildeを行末につけると文章が強調されます。(xxxx:~)
イコールを6つほど記載するとセクションを分けられます。(========)
複数行を強調するには、小なり、大なりで強調します。一行だけなら大なりは省略できます。(><)
codeハイライトをつけることもできます。(>vim)
コードハイライトを使用する場合vimrcで有効化する必要があります。
g:help_example_languages = {"vim":"vim","sh":"bash"}
特別なキーは<>の中に入れる <PageDown>
CtrlはCTRL-Xと表記する。
Note: Notes: でハイライトをつけられる。
*Todo *Errorもハイライトをつけられる。

基本的に使いそうなものはこんなところですかね。
さぁ書いてみよう。