barrett/preview.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 5

docs: add FAQ entry for redirecting markdown output to /tmp

Browse source 
Problem: the `markdown` and `github` presets write `.html` output to the
working directory, which clutters the project.

Solution: add a FAQ entry to both `README.md` and `doc/preview.txt`
showing how to override the `output` field to redirect to `/tmp`.
This commit is contained in:
Barrett Ruth 2026-03-11 15:41:56 -04:00
parent 39406c559c
commit f62e4470ad
2 changed files with 36 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -82,6 +82,22 @@ vim.g.preview = {
}
```
**Q: Markdown compilation drops `.html` files in my working directory. How do I
send output to `/tmp` instead?**
Override the `output` field. The `args` function references `ctx.output`, so the
compiled file lands wherever `output` points:
```lua
vim.g.preview = {
github = {
output = function(ctx)
return '/tmp/' .. vim.fn.fnamemodify(ctx.file, ':t:r') .. '.html'
end,
},
}
```
**Q: How do I set up SyncTeX (forward/inverse search)?**
See `:help preview-synctex` for full recipes covering Zathura, Sioyek, and

21
doc/preview.txt
View file

@ -27,7 +27,8 @@ CONTENTS *preview-contents*
7. Lua API ................................................... |preview-api|
8. Events ............................................... |preview-events|
9. Health ............................................... |preview-health|
10. SyncTeX ............................................. |preview-synctex|
10. FAQ ..................................................... |preview-faq|
11. SyncTeX ............................................. |preview-synctex|
==============================================================================
REQUIREMENTS *preview-requirements*
@ -314,6 +315,24 @@ Checks: ~
- Each configured provider's binary is executable
- Each configured provider's opener binary (if any) is executable
==============================================================================
FAQ *preview-faq*
Q: Markdown/GFM compilation drops `.html` files in my working directory.
How do I send output to `/tmp` instead?
A: Override the `output` field. The `args` function references `ctx.output`,
so the compiled file lands wherever `output` points: >lua
vim.g.preview = {
github = {
output = function(ctx)
return '/tmp/' .. vim.fn.fnamemodify(ctx.file, ':t:r') .. '.html'
end,
},
}
<
==============================================================================
SYNCTEX *preview-synctex*