Open a markdown file in vim and run
:MarkdownPreview. The preview opens in a new browser tab which will be reloaded whenever you
:write the buffer. If you accidentally close your browser tab or want to change the theme just run the command again. The file needs to be written to disk before you can start the preview.
live-server executables should be installed and accessible in your
$PATH. Please see the links in the description on how to install these programs on your system.
On macOS it could look something like:
$ brew install pandoc $ npm install -g live-server (or if you prefer yarn) $ yarn global add live-server
If you are using vim-plug
source the file (or restart vim) and then run
Take a look at
:help nvim-markdown-preview for documentation and examples.
Q: Why doesn't the preview update in real-time while I type in vim?
A: This plugin simply doesn't work like that. It is aimed to be "lightweigth" (if you already are a node.js/pandoc user that is).
It simply provides some live update capabilities around what is essentially
:w !pandoc % -o /tmp/file.html
Q: I want the preview tab to open automatically without typing
A: Sure, use an
autocmd FileType markdown MarkdownPreview
<Plug> mapping to bind it to the key of your choice
nmap <cr> <plug>(nvim-markdown-preview)
The markdown file must be written to disk first. It should be possible to use Pandoc
stdin and pipe the buffer content using
nvim-markdown-preview Copyright (C) 2018 David Granström This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.