kat0h/bufpreview.vim

A markdown previewer for Vim and Neovim

✨ 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

bufpreview.vim's Issues

TaskListで・を表示しないようにしたい

CSS4があれば楽そう(むり)

チェックボックスを子要素に持っている親要素の・を非表示にする...?

https://saruwakakun.com/html-css/basic/ul-ol-li

ADD TEST

Chromeでスクロールがひっかかる

chromeのsmooth-scrollが遅いため引っかかるような感触がある
改善できないか

プラグイン機構

yamlヘッダをレンダリング

---
test: "tst"
test2: "test"
---

Listenerのスペルが間違っている

ブラウザからwsが閉じられたときの終了処理

ブラウザからwsがcloseされたときにthis._socketをundefinedにする

Mermaid support

やれたらPR送ります!

参考:
markdown-it/markdown-it#929 (comment)

相対パスの時に、画像、Gifなどリンクに関するものを表示できない。

deps.tsに以下を追加し、serveDirを利用することで、開いているファイルのディレクトリを基準にアクセスできるようにすることを提案。

export { serveDir } from "https://deno.land/[email protected]/http/file_server.ts";

screen shot

Feature request: check box support

問題の概要

チェックボックス(task list の方が正しいですかね、、)がサポートされていないようなのでサポートされていると嬉しいです。

- [ ] test
- [ ] test2
- [ ] test3

• dps-bufpreviewでのプレビュー画面

• 期待するプレビュー画面(例: previm)
  • 先頭の「・」はなくても良いかもしれません(GitHub みたいなタイプ)

環境

• macOS Big Sur version 11.1
• vim 8.2.3450
• deno 1.14.1 (release, x86_64-apple-darwin)
• denops v2.0.0
  • https://github.com/vim-denops/denops.vim/releases/tag/v2.0.0

とても素敵なプラグインを作ってくれてありがとうございます。
他になにか手伝えることや必要な情報があれば教えてください！

Known issues

The server is easy to crash

CORSエラーで動作しなくなるときがある

DOMの差分更新

https://github.com/yhatt/markdown-it-incremental-dom
↑を使えるらしい. thanks > @tani

autocmdでプレビューすると、ブラウザでタブが2つ開く。

PreviewMarkdownでフラッシュ

私の環境(Neovim)だと，PreviewMarkdownを実行したときに下記のようにレンダリングが崩れます．

• Windows 10 (Windows Terminal and MobaXterm両方)
  • Ubuntu 20.04 WSL2
• Neovim 0.5.1
• Colorscheme: everforest

README.md._bufpreview.vim.-.NVIM.2021-10-09.17-47-44_Trim.mp4

ブラウザを開く関数をいじれるようにする

https://github.com/iamcco/markdown-preview.nvim/blob/master/README.md?plain=1#L116-L119

WSL Support

Pandoc サポート

素晴らしいプラグインをありがとうございます．Markdown-ItでPandoc風のMarkdown記法を表現できる拡張機能があるそうです．
Pandocの表示をシミュレーションできれば素晴らしいとおもいますので，ぜひご検討ください．

https://github.com/mb21/markdown-it-pandoc