vimdown

vimdownは値下げにvimrcのとて.vimスクリプトファイルを変換する汚いツールです。
ののインストール
インストールする最も簡単な方法は、PIPを使用することです
vimdownインストールPIP
それとも、GitHubのからインストールダウンロードを選ぶことができます
の概要の
Vimdownはマークダウンドキュメントにファイルを変換して.vim。
Vimdownは私の.vimrcが私て.vimディレクトリを保持している私のGitHubのリポジトリ用README.mkdファイルとして素敵に見えるようにかゆみから生まれた。
このReadmeには、vimのファイルとして書かれており、vimdownでマークダウンにレンダリングした。
Vimdownは、非常に単純なパーサーです。それがないすべては、テキストのブロックに別々のVimはファイルの連続した​​コメントや連続した非コメントのどちらかということです。コメントのブロックがラインのbeginingから、 '"'、彼らのコメントマークを剥奪し、マークダウン構文であると考えられている。非コメントブロックは、コードブロックとみなされ、明示的なvimの符号ブロックとして結果の値下げ文書に挿入されている。のみコメントの付いた行は、 '"'、行の第一または第二の文字として、コメントと見なされます。コメントマークは、後行で開始された場合には、コードブロック内のコメント付きコードとみなされます。
の使用法の
Vimdownはヘルプ出力を内蔵しています
> vimdown --help
基本
単にvimdownコマンドを処理するために、ファイルまたはファイルを与え、それが標準出力に結果をプリントアウトします：
> vimdown INFILE> OUTFILE
あなたは、出力ファイルを指定することができます。
> vimdown -o outfileにINFILE
複数の入力ファイルを使用する：
> vimdown INFILE infile2 infile3 -o OUTFILE
詳細の
のMarkdown2コードブロックの
あなたは、-cでmarkdown2スタイルのコードブロックを持つことができます。
> vimdown -c -o outfileにINFILE
つまり、のスタイルでマークダウンでコードブロックを作成します。
＆NBSP; ::: vimの
＆NBSP;コードはここにある
ののHTMLへのレンダリング
あなたがインストールされてmarkdown2している場合は、-tオプションを使ってあなたのためのHTMLにマークダウンをレンダリングするvimdown求めることができます。
これはOUTFILEにHTMLなどの基本的なマークダウンドキュメントをレンダリングします
> vimdown -t -o outfileにINFILE
これはINTO OUTFILEをHTMLとしてmarkdown2コードブロックにマークダウンドキュメントをレンダリングします
> vimdown -c -t -o outfileにINFILE
のPygmentsのスタイルの
あなたがMarkdown2とPygmentsの両方がインストールされている場合は、PygmentsのためのスタイルのコードマークアップとHTML文書として出力をレンダリングvimdown持つことができます。 -pオプションを使用します。
> vimdown -p -o outfileにINFILE
の例の
vimdownの現実の世界の使用状況を表示するには、Viming-WITH-ButtarsプロジェクトのREADMEをチェックアウト。
あなたがこれまでに文書で見てきたすべてがvimdownはvimのファイルのコメントをレンダリングする方法の例です。
コメントブロックは、行の最初または2番目の文字の位置に '"'コメント記号を持っている必要があります。
コメントブロック：
「＃件のコメント
「_comment_
"コメント
としてレンダリングされます：
コメント
コメント
コメント
別のコメントブロックは、コメントが余分なスペースで起動します：
＆NBSP; "[コメント]（http://google.com）
＆NBSP; "コメント
＆NBSP; "__comment__
のように表示されます。
コメント
コメント
コメント
これは、コードブロックとみなされる。
＆NBSP; "[コメント]（http://google.com）
＆NBSP; "＃コメント
＆NBSP; "コメント
としてレンダリング：
＆NBSP; "[コメント]（http://google.com）
＆NBSP; "＃コメント
＆NBSP; "コメント
以下の例は、コードブロックをレンダリングする方法である。
10 <変数の場合
= 0を変数：;＆NBSPは、Gましょう
ENDIF
コメント付きのコードブロック
filereadable場合（TSTR）
＆NBSP; "必ず私たちの大きなお尻のBSDのタグファイルを作成する
＆をタップ;」ならびにサブディレクトリに使用される。
＆NBSP;の行の末尾に設定されたタグ+ = TSTR "コメント
ENDIF