Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kat0h/bufpreview.vim
A markdown previewer for Vim and Neovim
https://github.com/kat0h/bufpreview.vim
deno denops vim
Last synced: about 2 months ago
JSON representation
A markdown previewer for Vim and Neovim
- Host: GitHub
- URL: https://github.com/kat0h/bufpreview.vim
- Owner: kat0h
- License: mit
- Created: 2021-09-25T02:32:24.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T13:08:01.000Z (almost 2 years ago)
- Last Synced: 2024-06-02T19:03:10.076Z (4 months ago)
- Topics: deno, denops, vim
- Language: TypeScript
- Homepage:
- Size: 688 KB
- Stars: 94
- Watchers: 1
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
✨ Markdown preview for Vim and Neovim ✨
> Powerd By [denops.vim](https://github.com/vim-denops/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](https://github.com/vim-denops/denops.vim)
- [Deno](https://deno.land) (>= 1.28.0)
- [Chrome](https://www.google.co.jp/chrome/)/[Safari](https://www.apple.com/jp/safari/)/[Firefox](https://www.mozilla.org/ja/firefox/new/)
### Install with [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'vim-denops/denops.vim'
Plug 'kat0h/bufpreview.vim', { 'do': 'deno task prepare' }
```
### Install with [dein.vim](https://github.com/Shougo/dein.vim), {'build': 'deno task prepare'}:
```vim
call dein#add('vim-denops/denops.vim')
call dein#add('kat0h/bufpreview.vim', {'build': 'deno task prepare'})
```
### Install with [minpac](https://github.com/k-takata/minpac)
```vim
call minpac#add('vim-denops/denops.vim')
call minpac#add('kat0h/bufpreview.vim', {'do': 'silent! !deno task prepare'})
```
### Install with [Vundle](https://github.com/VundleVim/Vundle.vim)
```vim
Plugin 'vim-denops/denops.vim'
Plugin 'kat0h/bufpreview.vim'
```
Then prepare the plugin manually where it was installed.
i.e.
```bash
cd ~/.vim/bundle/bufpreview.vim && deno task prepare
```
### Commands
```vim
" Start the preview
:PreviewMarkdown
" Stop the preview
:PreviewMarkdownStop
" Toggle the window
:PreviewMarkdownToggle
```
### Open preview window automatically
```vim
augroup bufpreview
autocmd!
autocmd Filetype markdown :PreviewMarkdown
augroup END
```
## Special Thanks
- [https://github.com/vim-denops/denops.vim](https://github.com/vim-denops/denops.vim)
- [https://github.com/iamcco/markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim)
- [https://github.com/previm/previm](https://github.com/previm/previm)
- [https://github.com/gamoutatsumi/dps-ghosttext.vim](https://github.com/gamoutatsumi/dps-ghosttext.vim)
- [Vim-jp](https://vim-jp.org/)
## License
MIT
this plugin uses these libraly
- https://github.com/digitalmoksha/markdown-it-inject-linenumbers
## Author
[Kota Kato](https://github.com/kat0h)