Realtime preview by Vim. (Markdown, reStructuredText, textile)
Clone or download
mattn Merge pull request #123 from previm/remove-installing-vim
it is possible that rmdir occur error.
Latest commit 23f3aab Jan 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autoload try/catch Jan 17, 2019
doc fix Dec 28, 2018
plugin add PrevimWipeCache command Nov 14, 2018
preview/_ Read files from base directory Jul 20, 2018
test Add missing file Jan 17, 2019
.appveyor.yml Add .appveyor.yml Jul 20, 2018
.gitignore Ignore changes in the preview dir (apart from _) so repo won't show c… Jul 31, 2018
.travis.yml Remove install vim Jan 17, 2019
LICENSE Update docs and note about previm developers Jul 20, 2018
README-en.mkd Cosmetic changes Jul 20, 2018
README.mkd Cosmetic changes Jul 20, 2018

README.mkd

README in English

Previm

TravisCI AppVeyor

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

previm

対応フォーマット

依存

変換のため

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に対応しています。

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

previm