https://github.com/euclio/vim-markdown-composer

An asynchronous markdown preview plugin for Vim and Neovim.
https://github.com/euclio/vim-markdown-composer

markdown neovim neovim-plugin rust vim vim-plugin

Last synced: 5 days ago
JSON representation

An asynchronous markdown preview plugin for Vim and Neovim.

• Host: GitHub
• URL: https://github.com/euclio/vim-markdown-composer
• Owner: euclio
• Created: 2015-07-28T04:45:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-28T06:44:24.000Z (11 months ago)
• Last Synced: 2024-10-12T18:48:02.076Z (3 months ago)
• Topics: markdown, neovim, neovim-plugin, rust, vim, vim-plugin
• Language: Rust
• Homepage:
• Size: 207 KB
• Stars: 625
• Watchers: 14
• Forks: 26
• Open Issues: 33
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vim-markdown-composer

![](https://github.com/euclio/vim-markdown-composer/workflows/Continuous%20integration/badge.svg)

vim-markdown-composer is a plugin that adds asynchronous Markdown preview to

[Neovim] and [Vim].

![](https://i.imgur.com/ZtyjjRD.gif)

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:

```vim

function! BuildComposer(info)

  if a:info.status != 'unchanged' || a:info.force

    if has('nvim')

      !cargo build --release --locked

    else

      !cargo build --release --locked --no-default-features --features json-rpc

    endif

  endif

endfunction

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

```

### Vundle

In your `.vimrc`:

```vim

Plugin 'euclio/vim-markdown-composer'

```

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

```sh

$ cd ~/.vim/bundle/vim-markdown-composer/

# Vim

$ cargo build --release --no-default-features --features json-rpc

# Neovim

$ cargo build --release

```

### Dein.vim

```

call dein#add('euclio/vim-markdown-composer', { 'build': '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.

## Plugin Options

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

```

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

[Rust]: http://www.rust-lang.org/

[cargo]: https://crates.io/

[Neovim]: https://neovim.io/

[Vim]: http://www.vim.org

[vim-instant-markdown]: https://github.com/suan/vim-instant-markdown

[Neovim remote plugin]: https://neovim.io/doc/user/remote_plugin.html

[vim-plug]: https://github.com/junegunn/vim-plug

[msgpack-rpc]: https://github.com/msgpack-rpc/msgpack-rpc

[aurelius]: https://github.com/euclio/aurelius

[stable Rust]: https://www.rust-lang.org/downloads.html

[Rust installation guide]: https://www.rust-lang.org/en-US/install.html