Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

preview markdown documents in the browser from vim

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.mkd

vim-markdown-preview

vim-markdown-preview adds the option to preview markdown documents in the browser from the vim editor.
The web page it opens is loosely styled on how GitHub would render README.mkd.

Install

Download

  • Option 1
    Cloning this repository is one option, and the master branch should always be in a working state.

  • Option 2
    You can download versioned releases from the downloads page.

Automatic installation
vim-markdown-preview is bundled with an installer script which will install to $HOME/.vim/plugin/

sh install.sh

Usage

Send vim the command :Mm for a preview of your markdown document.
Alternatively, bind :Mm to a key binding: map <leader>p :Mm<CR>

Dependencies

  • vim
  • Ruby support for vim.
  • kramdown (bundled with this package)

OSX

vim-markdown-preview was written to run on OSX, and it will work w/o problems.
I recommend the safari browser because it will not open new tabs needlessly if a document is already loaded in an existing tab/window.

Linux/Others

vim-markdown-preview is tied to the OSX command open.
You will need to replace it with something else - firefox-bin, for example, for it to work on your operating system.

Credit

  • Mathias Billman
    This is an enitrely rewritten version of the vim script originally written by Mathias Billman and found here.

  • moreweb
    Contributor.

  • maba
    Contributor.

Bugs

No known bugs right now. Found a bug?.

Contact

  • IRC
    irc.freenode.net/#flowof.info as 'robgleeson'

  • Mail
    rob [at] flowof.info

Something went wrong with that request. Please try again.