docs: pre-release polish

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.
This commit is contained in:
Barrett Ruth 2026-03-04 15:01:04 -05:00
parent 68e2e82232
commit 9260eaf8af
Signed by: barrett
GPG key ID: A6C96C9349D2FC81
2 changed files with 14 additions and 12 deletions

View file

@ -8,7 +8,7 @@ asynchronously with error diagnostics.
## Features ## Features
- Async compilation via `vim.system()` - Async compilation via `vim.system()`
- Built-in presets for Typst, LaTeX, Markdown, and GitHub-flavored Markdown - Built-in presets for Typst, LaTeX (latexmk, pdflatex, tectonic), Markdown, GitHub-flavored Markdown, AsciiDoc, and Quarto
- Compiler errors as native `vim.diagnostic` - Compiler errors as native `vim.diagnostic`
- User events for extensibility (`PreviewCompileStarted`, - User events for extensibility (`PreviewCompileStarted`,
`PreviewCompileSuccess`, `PreviewCompileFailed`) `PreviewCompileSuccess`, `PreviewCompileFailed`)
@ -38,13 +38,13 @@ luarocks install preview.nvim
```lua ```lua
require('preview').setup({ require('preview').setup({
typst = { rst = {
cmd = { 'typst', 'compile' }, cmd = { 'rst2html' },
args = function(ctx) args = function(ctx)
return { ctx.file } return { ctx.file, ctx.output }
end, end,
output = function(ctx) output = function(ctx)
return ctx.file:gsub('%.typ$', '.pdf') return ctx.file:gsub('%.rst$', '.html')
end, end,
}, },
}) })
@ -61,8 +61,8 @@ require('preview').setup({
**Q: How do I automatically open the output file?** **Q: How do I automatically open the output file?**
Set `open = true` on your provider (all built-in presets have this enabled) to 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. For open the output with `vim.ui.open()` after the first successful compilation in
a specific application, pass a command table: toggle/watch mode. For a specific application, pass a command table:
```lua ```lua
require('preview').setup({ require('preview').setup({

View file

@ -10,8 +10,9 @@ preview.nvim is an extensible framework for compiling documents asynchronously
in Neovim. It provides a unified interface for any compilation workflow — in Neovim. It provides a unified interface for any compilation workflow —
LaTeX, Typst, Markdown, or anything else with a CLI compiler. LaTeX, Typst, Markdown, or anything else with a CLI compiler.
The plugin ships with opt-in presets for common tools (Typst, LaTeX, Pandoc) The plugin ships with opt-in presets for common tools (Typst, LaTeX, Pandoc,
and supports fully custom providers. See |preview.nvim-presets|. AsciiDoc, Quarto) and supports fully custom providers.
See |preview.nvim-presets|.
============================================================================== ==============================================================================
REQUIREMENTS *preview.nvim-requirements* REQUIREMENTS *preview.nvim-requirements*
@ -89,9 +90,10 @@ Provider fields:~
|preview.Context|. |preview.Context|.
`open` boolean|string[] Open the output file after the first `open` boolean|string[] Open the output file after the first
successful compilation. `true` uses successful compilation in toggle/watch
|vim.ui.open()|. A string[] is run as mode. `true` uses |vim.ui.open()|. A
a command with the output path appended. string[] is run as a command with the
output path appended.
`reload` boolean|string[]|function `reload` boolean|string[]|function
Reload the output after recompilation. Reload the output after recompilation.