Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mattn/mkdpreview-vim

Markdown previewer for vimmer.
https://github.com/mattn/mkdpreview-vim

Last synced: about 1 month ago
JSON representation

Markdown previewer for vimmer.

Awesome Lists containing this project

README

        

MkdPreview
==========

Markdown Previewer for Vimmer.

Introduction
------------

Vim can't dispaly characters which have them glyphs for each like web browser.
So unfortunately, vimmer can't preview markdown text over editing on terminal.
This is a GUI application which can display preview of markdown.
This plugin support:

* Markdown
* reStructuredText
* Textile

Installation
------------

Just simple! Copy or git-clone mkdpreview-vim into your `~/.vim/bundle`.

# cd /path/to/your/.vimrc/bundle
# git clone https://github.com/mattn/mkdpreview-vim

This require following third party modules or vim plugins.

* python (2.7 or later)
* PyQt4
* Markdown in Python
* curl command
* webapi-vim

Usage
-----

:MkdPreview!

If you have previewer already, Just type:

:MkdPreview

`:MkdPreview!` command install `BufWritePost` hook for current buffer. Then preview will be updated just to do `:w`.

Screenshot
----------

![](https://github.com/mattn/mkdpreview-vim/raw/master/static/screenshot.png)

Author
------

Yasuhiro Matsumoto