✨ Markdown preview for Vim and Neovim ✨

Powerd By denops.vim🐜

introduction

Preview markdown on your browser.

Main features:

• 💻 Multi Pratform Support (Mac/Linux/Windows)
• 🙌 Supports Vim and Neovim
• 📡 Sync Cursor Position
• 🏃 Fast asynchronus updates
• 🎨 Syntax highlight
• 📊 Render yaml header
• 📈 Render plantUML
• ❤️ Simple Dependency and easy to install
• 🖋 KaTeX Support

install & usage

requirements

• denops.vim
• Deno (>= 1.28.0)
• Chrome/Safari/Firefox

Install with vim-plug

Plug 'vim-denops/denops.vim'
Plug 'kat0h/bufpreview.vim', { 'do': 'deno task prepare' }

Install with dein.vim, {'build': 'deno task prepare'}:

call dein#add('vim-denops/denops.vim')
call dein#add('kat0h/bufpreview.vim', {'build': 'deno task prepare'})

Install with minpac

call minpac#add('vim-denops/denops.vim')
call minpac#add('kat0h/bufpreview.vim', {'do': 'silent! !deno task prepare'})

Install with Vundle

Plugin 'vim-denops/denops.vim'
Plugin 'kat0h/bufpreview.vim'

Then prepare the plugin manually where it was installed.

i.e.

cd ~/.vim/bundle/bufpreview.vim && deno task prepare

Commands

" Start the preview
:PreviewMarkdown
" Stop the preview
:PreviewMarkdownStop
" Toggle the window
:PreviewMarkdownToggle

Open preview window automatically

augroup bufpreview
  autocmd!
  autocmd Filetype markdown :PreviewMarkdown
augroup END

Special Thanks

• https://github.com/vim-denops/denops.vim
• https://github.com/iamcco/markdown-preview.nvim
• https://github.com/previm/previm
• https://github.com/gamoutatsumi/dps-ghosttext.vim
• Vim-jp

License

MIT

this plugin uses these libraly

• https://github.com/digitalmoksha/markdown-it-inject-linenumbers

Author

Kota Kato