https://github.com/jutonic/inktex-watch
A companion binary for inkfig.nvim that monitors a directory for SVG file changes and autogenerates PDF and LaTeX overlays using Inkscape
https://github.com/jutonic/inktex-watch
inkscape latex neovim neovim-plugins rust
Last synced: 5 months ago
JSON representation
A companion binary for inkfig.nvim that monitors a directory for SVG file changes and autogenerates PDF and LaTeX overlays using Inkscape
- Host: GitHub
- URL: https://github.com/jutonic/inktex-watch
- Owner: JuTonic
- License: mit
- Created: 2025-08-02T22:18:02.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-08-06T17:55:32.000Z (7 months ago)
- Last Synced: 2025-10-10T05:25:58.726Z (5 months ago)
- Topics: inkscape, latex, neovim, neovim-plugins, rust
- Language: Rust
- Homepage: https://github.com/JuTonic/Inkwatch
- Size: 33.2 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Inktex-watch
**Inktex-watch** is a background CLI tool that watches a directory for changes to SVG files and automatically exports them to PDF and LaTeX overlay files using [Inkscape](https://inkscape.org). It is designed to be used alongside the [inktex.nvim](https://github.com/JuTonic/inktex.nvim) plugin to automate figure workflows in LaTeX documents.
## Usage
To start watching the `./figures` directory for changes, simply run:
```bash
inktex-watch ./figures
```
Whenever you create or save a file like:
```bash
./figures/picture.svg
```
inkwatch will automatically generate overlay files:
```bash
./figures/picture.pdf
./figures/picture.pdf_tex
```
If you delete `picture.svg`, the corresponding `.pdf` and `.pdf_tex` files will be deleted.
Avaliable options are:
```
inktex-watch [DIR] (OPTIONS)
[DIR] - REQUIRED
directory to watch for changes
(OPTIONS)
--help or -h Print this message
--version or -v Print version
--inkscape-path [PATH] Set path to inkscape binary
--aux-prefix [STR] Set prefix added to pdf and pdf_tex files
--do-not-regenerate Do not regenerate pdf and pdf_tex files at first run
--not-recursively Do not watch for changes in subdirectories
```
## Build
Prerequisites:
- Rust toolchain (see [rustup](https://rustup.rs/))
Run:
```
cargo install inktex-watch
```
Or build locally:
```bash
git clone https://github.com/JuTonic/inktex-watch.git
cd inktex-watch
cargo build --release
```
The binary will be created at `./target/release/inktex-watch`.
To install system-wide run:
```bash
cargo install --path .
```
Make sure that `~/.cargo/bin` is in your `PATH`