Repository files navigation

vim-markdown-composer is a plugin that adds asynchronous Markdown preview toNeovim andVim.

By default, vim-markdown-composer uses a blazing-fast CommonMark (andGitHub)-compliant renderer. However, it can be configured to use any externalprogram for rendering, such aspandoc.

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

This plugin supports Windows, macOS, and Linux.

In addition to Neovim or Vim, vim-markdown-composer requires a distribution ofRust withcargo. Check out theRust installation guide.

vim-markdown-composer officially targets the latest version ofstable Rust.

Use whatever plugin manager you like. If you aren't familiar with pluginmanagers, I recommendvim-plug.

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

function!BuildComposer(info)ifa:info.status!='unchanged'||a:info.forceifhas('nvim')!cargo build--release--lockedelse!cargo build--release--locked--no-default-features --features json-rpcendifendifendfunctionPlug'euclio/vim-markdown-composer', {'do':function('BuildComposer') }

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

call dein#add('euclio/vim-markdown-composer', { 'build': 'cargo build --release' })

You should runcargo build --release in the plugin directory afterinstallation. Vim support requires thejson-rpc cargo feature.

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

By default,vim-markdown-composer will open a new browser tab with the rendered preview. This can be prevented by setting the following in your Vim configuration:

let g:markdown_composer_autostart = 0

:help markdown-composer, or check out thedoc directory.

This plugin is inspired by suan'svim-instant-markdown.

This plugin was built withaurelius, a Rust library for live-updating Markdownpreviews.