Files
servtex/README.md
Maximilian Wagner dd5e6f9195 changed readme
2025-12-28 01:05:15 +01:00

35 lines
1.2 KiB
Markdown

## ServTeX
ServTeX is a webserver which auto-compiles your LaTeX project and serves it without any input.
It is intended to be run on a second monitor while you edit your project on the first.
Syncing is not handled directly by ServTeX so you can use syncthing, rsync, etc.
I made this because I wanted something like this. I have been learning Goland along the way, so some code may seem odd.
### AI-Disclaimer
> No Vibe Coding
The code has been minimally touched by AI in the form of helping me figure out the syntax and language oddities of Golang.
To reduce the 404s I also generated the favicon.
### Usage
Download the latest release.
Extract to an empty directory and change the configuration as needed.
Configure syncing via a solution of your choice and start the server.
### Development
```go
go build
./servtex
```
or `make`, which contains the same.
### Help Wanted
Some nice to have features are missing. Feel free to open an issue if you want to tackle them or propose a new feature.
- Multi user support
- Basic Authentication / OAuth
- Configurable per-user rate limiting
- Embedded PDF viewer that is more suitable for this than a browser
- Obsidian.md plugin including the syncing logic on both ends
- Better UI (me no frontend guy)