Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thlorenz/pdf-annotations-converter
Converts annotations found in PDF files to different formats.
https://github.com/thlorenz/pdf-annotations-converter
Last synced: 2 months ago
JSON representation
Converts annotations found in PDF files to different formats.
- Host: GitHub
- URL: https://github.com/thlorenz/pdf-annotations-converter
- Owner: thlorenz
- License: mit
- Created: 2020-09-09T01:25:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-11T05:17:37.000Z (over 4 years ago)
- Last Synced: 2024-04-14T15:37:09.229Z (9 months ago)
- Language: Rust
- Homepage:
- Size: 37.1 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pdf-annotations-converter [](https://github.com/thlorenz/pdf-annotations-converter/actions)
Converts annotations found in PDF files to different formats.
```
USAGE:
cat annotations.txt | pdf-annotations-converter [OPTIONS] > notes.md
FLAGS:
-h, --help Prints help information
-n, --numbers Flag specifying if page numbers should be included
-V, --version Prints version information
OPTIONS:
-a, --add-offset Added to annotated page numbers to obtain physical page
-s, --sub-offset Subtracted from annotated physical page to obtain page number
Physical pages don't usually match page numbers. Therefore you can optionally provide an offset to
derive one from the other.
First determine the page offset which is the physical page on which page number `1` appears.
Then provide this offset via `--add-offset` if the annotations include the actual page number or via
`--sub-offset` if the annotations include the physical page.
```
## Installation
```sh
cargo install pdf-annotations-converter
```
## Supported Annotations
At this point annotations generated with [GoodReader](https://goodreader.com/) are supported.
These annotations are obtained by using the [export via
email](https://goodreader.com/user-manual/export-annotations) feature.
No email account needs to be connected to do this as you can just pretend to send them via
email and copy them to the clipboard to them transfer them via a different mechanism, i.e. via
Notes.
## Supported Renderers
At this point rendering to markdown is supported.
## Documentation
- [crates.io documentation](https://crates.io/crates/pdf-annotations-converter)
## License
MIT