Update README preset list to include pdflatex, tectonic, asciidoctor,
and quarto. Fix custom provider FAQ example to use a non-preset key.
Clarify open field fires on toggle/watch mode only, not :Preview compile.
Expand intro to mention AsciiDoc and Quarto alongside existing tools.

2026-03-04 15:01:04 -05:00

1.5 KiB

Raw Blame History

preview.nvim

Async document compilation for Neovim

An extensible framework for compiling documents (LaTeX, Typst, Markdown, etc.) asynchronously with error diagnostics.

Features

Async compilation via vim.system()
Built-in presets for Typst, LaTeX (latexmk, pdflatex, tectonic), Markdown, GitHub-flavored Markdown, AsciiDoc, and Quarto
Compiler errors as native vim.diagnostic
User events for extensibility (PreviewCompileStarted, PreviewCompileSuccess, PreviewCompileFailed)

Requirements

Neovim 0.11+

Installation

Install with your package manager of choice or via luarocks:

luarocks install preview.nvim

Documentation

:help preview.nvim

FAQ

Q: How do I define a custom provider?

require('preview').setup({
  rst = {
    cmd = { 'rst2html' },
    args = function(ctx)
      return { ctx.file, ctx.output }
    end,
    output = function(ctx)
      return ctx.file:gsub('%.rst$', '.html')
    end,
  },
})

Q: How do I override a preset?

require('preview').setup({
  typst = { env = { TYPST_FONT_PATHS = '/usr/share/fonts' } },
})

Q: How do I automatically open the output file?

Set open = true on your provider (all built-in presets have this enabled) to open the output with vim.ui.open() after the first successful compilation in toggle/watch mode. For a specific application, pass a command table:

require('preview').setup({
  typst = { open = { 'sioyek', '--new-instance' } },
})

1.5 KiB Raw Blame History