barrettruth

barrettruth / preview.nvim

Public

universal previewer for neovim

46
0
100% credibility
Found Mar 07, 2026 at 46 stars -- GitGems finds repos before they trend. Get early access to the next one.
Sign Up Free
AI Analysis
Lua
AI Summary

preview.nvim is a Neovim plugin providing an extensible framework for async compilation, live previewing, and diagnostics of documents in formats like LaTeX, Typst, Markdown, and more.

How It Works

1
🔍 Discover the preview tool

While writing documents like reports or notes in your text editor, you find a helpful add-on that lets you see live previews as you type.

2
🛠️ Add it to your editor

Easily include the tool in your editor's setup and choose which types of documents you want to preview, like notes or papers.

3
📄 Open your document

Load your document file, such as a Markdown note or math paper, into your editor.

4
🚀 Start live preview

With one simple command, turn on previewing – it starts building your document and shows the result right away.

5
✏️ Edit and watch updates

Make changes to your writing, and the preview refreshes automatically without you lifting a finger.

6
✅ Spot and fix issues

Helpful notes appear exactly where problems are in your text, guiding you to perfect it quickly.

🎉 View your polished document

Open the beautiful final version, like a PDF or webpage, perfectly matching your edits and ready to share.

Sign up to see the full architecture

5 more

Sign Up Free

Star Growth

See how this repo grew from 46 to 46 stars Sign Up Free
Repurpose This Repo

Repurpose is a Pro feature

Generate ready-to-use prompts for X threads, LinkedIn posts, blog posts, YouTube scripts, and more -- with full repo context baked in.

Unlock Repurpose
AI-Generated Review

What is preview.nvim?

preview.nvim is a Lua plugin for Neovim acting as a universal previewer for documents like Typst, LaTeX, Markdown, PlantUML, Mermaid, AsciiDoc, and Quarto. It compiles files asynchronously, shows diagnostics in Neovim or quickfix, and auto-opens previews with optional live reload and SyncTeX support. Tired of juggling tools like chomusuke/typst-preview.nvim or markdown preview nvim github extensions? This handles it all in one extensible framework.

Why is it gaining traction?

Built-in presets cover Typst watch mode, latexmk/pdflatex/tectonic, GitHub-flavored Markdown, and preview nvim plantuml needs, outperforming siloed options like oil nvim preview. Commands like `:Preview toggle` start watching with debounced recompiles on save, auto-opening outputs via vim.ui.open or custom apps like Sioyek. Custom providers and health checks make it dead simple to extend for vim preview workflows.

Who should use this?

Neovim users writing academic papers in Typst or LaTeX who need SyncTeX forward/inverse search. Technical writers previewing GitHub-flavored Markdown or Quarto docs. Diagram authors using PlantUML or Mermaid wanting SVG outputs without external servers.

Verdict

Early project at 46 stars and 1.0% credibility score means watch for stability, but excellent docs, presets, and :checkhealth make it viable now for Neovim 0.11+ power users seeking a universal previewer over fragmented alternatives. Try it if specialized tools fall short.

Sign up to read the full AI review Sign Up Free

Similar repos coming soon.