Skip to content
An asynchronous markdown preview plugin for Vim and Neovim.
Branch: master
Clone or download
Latest commit 2e5fe51 May 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
after/ftplugin/markdown update dependencies Jan 28, 2018
config set default logging level to "error" Aug 17, 2016
doc update dependencies Jan 28, 2018
src upgrade dependencies Apr 28, 2019
.gitignore replace python plugin with vimscript Dec 29, 2016
.gitmodules initial commit Jul 28, 2015
.travis.yml enable travis.ci integration Nov 20, 2015
Cargo.lock Update dependencies May 13, 2019
Cargo.toml upgrade dependencies Apr 28, 2019
README.md fix simple typo Oct 19, 2018

README.md

vim-markdown-composer

Build Status

vim-markdown-composer is a plugin that adds asynchronous Markdown preview to Neovim and Vim.

By default, vim-markdown-composer uses a blazing-fast CommonMark (and GitHub)-compliant renderer. However, it can be configured to use any external program for rendering, such as pandoc.

Requirements

This plugin requires Neovim or Vim 8. If you are using an OS with Vim pre-installed, the system Vim might be too old (see vim --version).

This plugin supports Windows, macOS, and Linux.

In addition to Neovim or Vim, vim-markdown-composer requires a distribution of Rust with cargo. Check out the Rust installation guide.

vim-markdown-composer officially targets the latest version of stable Rust.

Installation

Use whatever plugin manager you like. If you aren't familiar with plugin managers, I recommend vim-plug.

vim-plug

Here's an example of managing installation with vim-plug:

function! BuildComposer(info)
  if a:info.status != 'unchanged' || a:info.force
    if has('nvim')
      !cargo build --release
    else
      !cargo build --release --no-default-features --features json-rpc
    endif
  endif
endfunction

Plug 'euclio/vim-markdown-composer', { 'do': function('BuildComposer') }

Vundle

In your .vimrc:

Plugin 'euclio/vim-markdown-composer'

Once you have installed the plugin, close Vim/Neovim then (on Linux):

$ cd ~/.vim/bundle/vim-markdown-composer/
# Vim
$ cargo build --release --no-default-features --features json-rpc
# Neovim
$ cargo build --release

Other plugin managers

You should run cargo build --release in the plugin directory after installation. Vim support requires the json-rpc cargo feature.

If you use the above snippet, everything should be taken care of automatically.

Documentation

:help markdown-composer, or check out the doc directory.

Acknowledgments

This plugin is inspired by suan's vim-instant-markdown.

This plugin was built with aurelius, a Rust library for live-updating Markdown previews.

You can’t perform that action at this time.