Introduction
Preview markdown in your browser from Neovim and Vim, with live updates, math, diagrams and themes.
markdown-preview.nvim opens the markdown buffer you are editing in your browser. The page updates as you type, before you save, and scrolls along with the cursor. It renders math, diagrams and GitHub-flavoured markdown, and takes the look of any shadcn/ui theme.
It works in Neovim and Vim 8.1+, on macOS, Linux, FreeBSD and Windows. The plugin runs one small server binary, which it downloads for you. Everything is bundled into the binary, so it runs offline (no CDN).
Fork of iamcco/markdown-preview.nvim.
Getting started
Quickstart
Install, open your first preview, and change the settings most people change.
Installation
Every plugin manager, building from source, and moving from iamcco/markdown-preview.nvim.
Features
Live preview
Refreshing, synchronised scrolling, one page for several buffers.
Markdown
Alerts, tables of contents, task lists, footnotes, emoji, math, images and front matter.
Diagrams
Mermaid and its full-screen viewer, Chart.js, Graphviz, PlantUML and more.
Theming
Light and dark, shadcn/ui and tweakcn themes, fonts, and your own CSS.
Browser and sharing
Choosing the browser, WSL, remote machines, sharing on your network, hooks.