diff --git a/README.html b/README.html
new file mode 100644
index 0000000..b6600fc
--- /dev/null
+++ b/README.html
@@ -0,0 +1,963 @@
+
+
+
+
+
+
+ README
+
+
+
+
+preview.nvim
+Universal document previewer for Neovim
+An extensible framework for compiling and previewing any
+documents (LaTeX, Typst, Markdown, etc.)—diagnostics included.
+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
+
+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' } },
+})