---

Ⅰ. 插件描述

Realtime preview by Vim. (Markdown, reStructuredText, textile)

Ⅱ. 基本信息

创建日期：  2013-06-22 使用用户：  10 Github星：  1 插件作者：  Kazuhiro Homma

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'kazuph/previm-hands-off'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'kazuph/previm-hands-off'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'kazuph/previm-hands-off'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/kazuph/previm

Ⅳ. 文档说明

README in English

Previm

プレビュー用のVimプラグインです。

対応フォーマット

• Markdown

  • support mermaid
• reStructuredText
• textile

依存

変換のため

Markdownとtextileの場合は必須なものはありません。
reStructuredTextの場合はrst2html.pyが必要です。
docutilsをインストールするとrst2html.pyコマンドが使えるようになります。

% pip install docutils
% rst2html.py --version
rst2html.py (Docutils 0.12 [release], Python 2.7.5, on darwin)

プレビューを開くため

必須なものはありません。
open-browser.vimは任意で使用できます。

使い方(Markdownの場合)

1. .vimrc にて g:previm_open_cmd を定義します

   • この値はコマンドラインから実行できるコマンドです
   • たとえばMacなら open -a Safari などです
   • :help g:previm_open_cmd を参照してください
   • open-browserを使う場合は設定不要です

2. filetype がMarkdownのファイルの編集を開始します

   • 注意:拡張子が.mdの場合はmarkdownではなくmodula2として認識されてしまいます。その場合は以下の設定を.vimrcに記述してください

   augroup PrevimSettings
       autocmd!
       autocmd BufNewFile,BufRead *.{md,mdwn,mkd,mkdn,mark*} set filetype=markdown
   augroup END

3. :PrevimOpen を実行してブラウザを開きます
4. 元のVimバッファに戻り編集を続けます
5. 変更の度にブラウザの表示内容が更新されます

mermaid

mermaidに対応しています。

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->E;