sponsor Vim development Vim logo Vim Book Ad

markdown-preview.vim : preview markdown through browser with no external dependencies

 script karma  Rating 10/4, Downloaded by 1997  Comments, bugs, improvements  Vim wiki

created by
yuuko aioi
 
script type
utility
 
description
Use the markdown-preview.vim plugin you can preview markdown on real-time through a browser

> this plugin need your vim support py2/py3 features
> test on windows/ubuntu14

screenshot
https://raw.githubusercontent.com/iamcco/markdown-preview.vim/master/screenshot.gif

sources
https://github.com/iamcco/markdown-preview.vim

Usage

Command:

    MarkdownPreview
    \" open preview window in markdown buffer

    MarkdownPreviewStop
    \" close the preview window and server

when MarkdownPreview command can't open preview window, you can use the MarkdownPreviewStop command before using MarkdownPreview command
Defaul Setting:

    let g:mkdp_path_to_chrome = \"google-chrome\"
    \" path to the chrome or the command to open chrome(or other modern browsers)

    let g:mkdp_auto_start = 0
    \" set to 1, the vim will open the preview window once enter the markdown
    \" buffer

    let g:mkdp_auto_open = 0
    \" set to 1, the vim will auto open preview window when you edit the
    \" markdown file

    let g:mkdp_auto_close = 1
    \" set to 1, the vim will auto close current preview window when change
    \" from markdown buffer to another buffer

    let g:mkdp_refresh_slow = 0
    \" set to 1, the vim will just refresh markdown when save the buffer or
    \" leave from insert mode, default 0 is auto refresh markdown as you edit or
    \" move the cursor
 
install details
1. normal install

Put the plugin/mkdp.vim file into your ~/.vim/plugin (or $HOME\\\\vimfiles\\\\plugin) directory.
Put the doc/mkdp.txt into your ~/.vim/doc (or $HOME\\\\vimfiles\\\\doc) directory.
Put all the files in the autoload/ directory into your ~/.vim/autoload (or $HOME\\\\vimfiles\\\\autoload) directory.

Run \":helptags ~/.vim/doc\" (\":helptags $HOME/vimfiles/doc\")


2. install with Vundle (recommended)

put Plugin 'iamcco/markdown-preview.vim' to the .vimrc/_vimrc file and run:PluginInstall
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
markdown-preview.vim-0.2.2.zip 0.2.2 2016-02-22 7.4 yuuko aioi fix bug on neovim for opening browser
markdown-preview.vim-0.2.1.zip 0.2.1 2016-02-05 7.4 yuuko aioi fix the bug on *unix system
https://github.com/iamcco/markdown-preview.vim/issues
markdown-preview.vim-0.2.0.zip 0.2.0 2016-02-03 7.4 yuuko aioi Initial upload
ip used for rating: 3.238.118.80

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
OSDN