sponsor Vim development Vim logo Vim Book Ad

Vim Markdown Preview : A Vim plugin for previewing markdown files in a browser.

 script karma  Rating 53/32, Downloaded by 1635  Comments, bugs, improvements  Vim wiki

created by
Jamshed Vesuna
 
script type
utility
 
description
A Vim plugin for previewing markdown files in a browser. This plugin was designed to maintain focus on Vim but use Google Chrome to preview rendered markdown. Thus, everything is done in the background so you never have to leave vim.

For more the most updated version, more details, and a screenshot see: https://github.com/JamshedVesuna/vim-markdown-preview

Usage

When in a *.markdown or *.md file, vim-markdown-preview does the following on a write to the buffer:
    1. If you are not previewing the current file:
            Open an html rendered version of your file in Google Chrome in the background.
    2. Otherwise:
            Refresh your preview of the current markdown file in Google Chrome.
Uncomment the last line in plugin/vim-markdown-preview.vim to map Ctrl-p to the above instead of on write.

Behind The Scenes:

    1. First, vim-markdown-preview renders your markdown as html and creates a temporary file vim-markdown-preview.html in /tmp/.
    2. Next, vim-markdown-preview then either opens the html file or refreshes the Google Chrome tab.
    3. Lastly, vim-markdown-preview removes the temporary file so nothing left behind.

Requirements:

    1. Markdown
    2. xdotool
    3. Google Chrome
 
install details
With Pathogen: Place vim-markdown-preview/ in .vim/bundle/.
 

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
vim-markdown-preview.zip 0.2 2014-08-27 7.0 Jamshed Vesuna Added screenshot gif
vim-markdown-preview.zip 7.0 2014-08-26 7.0 Jamshed Vesuna Initial upload
ip used for rating: 44.204.204.14

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.
   
Vim at Github