https://github.com/franco-ruggeri/pdf-preview.nvim
Neovim plugin for live PDF preview - LaTeX workflow in containers
https://github.com/franco-ruggeri/pdf-preview.nvim
containers latex neovim neovim-lua neovim-plugin
Last synced: 4 months ago
JSON representation
Neovim plugin for live PDF preview - LaTeX workflow in containers
- Host: GitHub
- URL: https://github.com/franco-ruggeri/pdf-preview.nvim
- Owner: franco-ruggeri
- License: mit
- Created: 2025-06-05T22:33:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-06-29T07:42:31.000Z (4 months ago)
- Last Synced: 2025-06-29T08:19:28.116Z (4 months ago)
- Topics: containers, latex, neovim, neovim-lua, neovim-plugin
- Language: Lua
- Homepage:
- Size: 1.99 MB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PDF Preview 🧾🔍
## 📚 Overview
A Neovim plugin for easily previewing PDF documents in your browser, with
automatic reloading on file changes. This plugin is ideal for a minimalist LaTeX
editing workflow, even on a remote server or in a dev container.
## ✨ Features
- 🔄 Auto-reloading: Refreshes the browser when your PDF file changes.
- 🔌 Remote-friendly: Works over SSH with port forwarding.
- 🪞 Transparent: No side effects in your project.
- ⚙️ Minimal config: Simple `setup()` with sensible defaults.
## ⚡ Requirements
- Node.js (for `npm` and `npx`)
## 📦 Installation
Using [lazy.nvim](https://github.com/folke/lazy.nvim) :
```lua
{
"franco-ruggeri/pdf-preview.nvim",
opts = {
-- Override defaults here
}
config = function(_, opts)
require("pdf-preview").setup(opts)
-- Add your keymaps here
end
}
```
## 🚀 Usage
The following user commands are created:
- `:PdfPreviewStart` : Start PDF preview.
- `:PdfPreviewStop` : Stop PDF preview.
- `:PdfPreviewToggle` : Toggle PDF preview.
After using `:PdfPreviewStart`, open the printed URL (e.g.,
) in your browser.
## 🛠️ Configuration
The default configuration is as follows:
```lua
{
-- Port where the browser-sync server will try to listen on.
-- If nil, the default browser-sync behavior will be followed.
port = nil,
-- Debounce delay for refresh events in milliseconds
reload_debouce = 500,
}
```
## 💡 Workflow Tips
### 🧪 LaTeX
This plugin works nicely with LaTeX. Just compile the LaTeX project into a PDF
document.
For instance, you can:
- Install the `texlab` LSP server using `mason.nvim`.
- Configure `texlab` to compile on save.
```lua
vim.lsp.config("texlab", {
settings = {
texlab = {
build = {
onSave = true,
},
},
},
})
```
The `texlab` LSP server will take care of compiling on save, and `pdf-preview`
will watch for changes in the output PDF document.
### 🌐 Remote server
You can use SSH port forwarding to view the PDF remotely:
```bash
ssh -L :localhost: @
```
### 🐳 Dev container
You can use port forwarding by setting the `forwardPorts` property. See the
[official documentation](https://containers.dev/implementors/json_reference/).
## 🤝 Contributing
All contributions are welcome! Open an issue to discuss ideas and open a pull
request once agreed.