https://github.com/oxplot/pdfrankenstein
PDF Annotator of Nightmares 🎃
https://github.com/oxplot/pdfrankenstein
annotator linux pdf
Last synced: 7 months ago
JSON representation
PDF Annotator of Nightmares 🎃
- Host: GitHub
- URL: https://github.com/oxplot/pdfrankenstein
- Owner: oxplot
- License: bsd-3-clause
- Created: 2022-03-16T05:22:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-22T04:08:11.000Z (9 months ago)
- Last Synced: 2025-03-31T04:04:41.245Z (7 months ago)
- Topics: annotator, linux, pdf
- Language: Go
- Homepage:
- Size: 160 KB
- Stars: 191
- Watchers: 6
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
PDFrankenstein is a GUI PDF annotator which uses Inkscape for editing.
## What can you do with it?
- Put your signature on documents.
- Fill forms.
- Add clickable links.
- Draw on documents and highlight areas.
- Multiple page PDFs are supported.
- Anything you can do in Inkscape.
## Requirements
- Recent version of [Inkscape](https://inkscape.org/)
- [poppler-utils](https://poppler.freedesktop.org/)
- [qpdf](https://github.com/qpdf/qpdf) `>=10.0.2`
- Go 1.18 (build only)
## Install
Packages are available for:
- [Arch Linux](https://aur.archlinux.org/packages/pdfrankenstein): `yay -S pdfrankenstein`
- [mise](https://mise.jdx.dev/): `mise use -g ubi:oxplot/pdfrankenstein`
## Download
Download the latest version from the [releases
page](https://github.com/oxplot/pdfrankenstein/releases). Alternatively,
you can checkout and build the code:
```sh
git clone https://github.com/oxplot/pdfrankenstein.git
cd pdfrankenstein
go build # This will take a LOOOOONG time
./pdfrankenstein
```
## How does it work?
When you select a page to annotate, it's converted to SVG, made into a
locked background of another SVG which is opened in Inkscape for you to
draw on. After annotating all the pages needed, saving the file will go
through all the annotated pages, and for each removes the added
background, exports the page to PDF and finally overlays each annotation
on the corresponding page of the orignal PDF and outputs the final file.
Inkscape is used much like `vim` or `emacs` are used as your editor in
the shell when you run `crontab -e`. Instead of `crontab` implementing
its own editor, it creates a temporary file, runs `vim` and checks if
the file is updated after `vim` is closed.