peek.nvim
A live markdown preview plugin for Neovim with synchronized scrolling, GitHub-style rendering, and diagram support.
What is peek.nvim?
Peek.nvim is a markdown preview plugin for Neovim that provides a live preview window alongside the editor. It enables developers to see rendered markdown in real-time as they write documentation or notes without leaving their editor environment, featuring GitHub-style rendering with support for mathematical equations and diagrams.
Neovim users who write markdown documentation, notes, or technical content within the editor and want a seamless, integrated preview experience.
Developers choose Peek.nvim for its tight integration with Neovim, offering live updates, synchronized scrolling, and customizable preview options without requiring external applications. Its unique selling point is the ability to render complex markdown elements like TeX math and Mermaid diagrams directly within the editor environment.
Overview
Markdown preview plugin for Neovim
Use Cases
Best For
- Writing markdown documentation in Neovim with real-time visual feedback
- Previewing technical documentation containing mathematical equations rendered with KaTeX
- Creating and viewing Mermaid diagrams and flowcharts within markdown files
- Maintaining synchronized scrolling between markdown source and preview windows
- Customizing markdown preview themes and behavior to match workflow preferences
- Integrating markdown previews with window managers like i3wm for advanced layout control
Not Ideal For
- Users who need advanced markdown features beyond KaTeX and Mermaid, such as custom extensions or third-party plugins
- Environments where Deno cannot be installed or is prohibited due to security or policy constraints
- Projects requiring real-time collaborative editing or cloud-based markdown previews with multi-user support
- Developers who prefer using Vim over Neovim, as the plugin is specifically designed for Neovim's APIs
Pros & Cons
Pros
Preview updates in real-time as you type, and scrolling is synchronized between the editor and preview window, providing a seamless editing flow without manual refreshes.
Renders mathematical equations using KaTeX and diagrams with Mermaid, making it ideal for technical documentation, academic notes, or any markdown with complex elements.
Offers configurable themes (dark/light), update behavior, and choice of preview app (webview or browser), allowing users to tailor the experience to their workflow.
Works with window managers like i3wm for advanced layout control, enabling automated window placement and management through scripts, as detailed in the README.
Cons
Requires Deno installation, adding an external runtime dependency that may complicate setup or cause issues on systems without Deno support.
Syntax highlighting can affect performance, and large files trigger throttling (with throttle_at and throttle_time settings), potentially delaying preview updates.
Relies on external webview or browser for rendering, which may lack consistency across environments and limit deep integration with Neovim's native features.
Frequently Asked Questions
Related Projects
markdown-preview.nvimmarkdown preview plugin for (neo)vim
render-markdown.nvimPlugin to improve viewing Markdown files in Neovim
markview.nvimA hackable markdown, Typst, latex, html(inline) & Asciidoc previewer for Neovim
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.