Skip to content
Realtime preview by Vim. (Markdown, reStructuredText, textile)
Vim script JavaScript CSS HTML Shell
Branch: master
Clone or download

Latest commit

mattn Merge pull request #145 from tsuyoshicho/fix/gitignore
fix: gitignore do not run autocrlf
Latest commit e42063e Apr 7, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autoload Merge pull request #140 from ryotatake/fix_wsl_mode_for_fish Jan 15, 2020
doc Update doc Nov 10, 2019
plugin add PrevimWipeCache command Nov 14, 2018
preview/_ Add g:previm_plantuml_imageprefix Nov 7, 2019
test Add missing file Jan 17, 2019
.appveyor.yml
.gitattributes gitignore : fix autocrlf work Mar 13, 2020
.gitignore Add plantuml plugin Oct 5, 2018
.travis.yml [add] some vim's version test Feb 10, 2020
LICENSE Update docs and note about previm developers Jul 20, 2018
README-en.mkd
README.mkd Add documentation about PlantUML Jan 23, 2020

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

Safari13.0.3ではブラウザが「Loading...」のままで止まってしまうことが報告されています

previmを動作させるために以下の設定をしてください

  1. メニューバーの Safari > 環境設定 > 詳細 > メニューバーに"開発"メニューを表示にチェック
  2. メニューバーの 開発 > ローカルファイルの制限を無効にする を選択

mermaid

mermaidに対応しています。

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

previm

PlantUML

PlantUML に対応しています。

```plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
```

PlantUML preview

You can’t perform that action at this time.