~dricottone/vim-markdown-preview

ref: 2be6693d4e01132e410a14971e45d06a2d978073 vim-markdown-preview/README.md -rw-r--r-- 1.4 KiB
2be6693d — Jamshed Vesuna Merge pull request #5 from zeebo404/master 9 years ago

#Vim Markdown Preview

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.

Screenshot

#Installation

  1. With Pathogen: Place vim-markdown-preview/ in .vim/bundle/.

#Requirements

#Usage

When in a *.markdown or *.md file, vim-markdown-preview does the following when you type Ctrl-p:

  • If you are not previewing the current file:
    • Open an html rendered version of your file in Google Chrome in the background.
  • Otherwise:
    • Refresh your preview of the current markdown file in Google Chrome.

Uncomment the last line in plugin/vim-markdown-preview.vim to map a buffer write to the above instead of Ctrl-p.

#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. If you would like vim-markdown-preview to remove the temporary file so nothing left behind, uncomment lines 20 and 21.