~dricottone/vim-markdown-preview

ref: 2d5e5346d21a2352515b5ab27439cac3847b848b vim-markdown-preview/README.md -rw-r--r-- 1.2 KiB
2d5e5346 — Jamshed Vesuna Added background tab refreshing. 10 years ago

#Vim Markdown Preview

A vim plugin for previewing markdown files in a browser. This plugin was designed to maintan 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.

#Installation

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

#Requirements

#Usage

When in a *.markdown or *.md file, vim-markdown-preview maps Ctrl-p as follows:

  • 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.

#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.