Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JCN-9000/pdf2rmnotebook

Create reMarkable notebook file from multiple PDFs
https://github.com/JCN-9000/pdf2rmnotebook

remarkable-tablet

Last synced: 25 days ago
JSON representation

Create reMarkable notebook file from multiple PDFs

Host: GitHub
URL: https://github.com/JCN-9000/pdf2rmnotebook
Owner: JCN-9000
License: gpl-3.0
Created: 2021-05-26T14:50:06.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-08T23:23:27.000Z (8 months ago)
Last Synced: 2024-08-03T17:10:07.167Z (4 months ago)
Topics: remarkable-tablet
Language: Shell
Homepage:
Size: 3.15 MB
Stars: 35
Watchers: 3
Forks: 5
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-reMarkable - pdf2rmnotebook - Creates a reMarkable Notebook from multiple PDF files. (Other / Launchers)

README

# pdf2rmnotebook

[![rm1](https://img.shields.io/badge/rM1-supported-green)](https://remarkable.com/store/remarkable)
[![rm2](https://img.shields.io/badge/rM2-supported-green)](https://remarkable.com/store/remarkable-2)
[![Discord](https://img.shields.io/discord/385916768696139794.svg?label=reMarkable&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/ATqQGfu)

Creates a reMarkable Notebook from multiple PDF or PNG files compatible with RCU and rmapi.

## Changelog

Version
- V1.1 - All pdf pages are converted, no need to split file ( needs pdfinfo command )
- V1.2.0 - Some options added: Verbosity, Usage, Version; Cleanup and Checks
- V2.1.0 - Image formats png/jpg can be directly converted
- -s option to scale notebook page size to ~A4
- V2.2.0 - Convert to `rmn` files compatible with RCU
- -r option to create `rmn` files

## Example

Combine multiple PDFs into a single, editable reMarkable (`.rmn`) document

`$ ./pdf2rmnotebook.sh -r ./example/2d-3.pdf ./example/3d-1.pdf`

The two PDFs are now combined and can be edited on the remarkable using all the standard tools:
![Combined PDF Example](./example/combined_example.png)

## Requirements

- [drawj2d](https://sourceforge.net/projects/drawj2d/)
- pdfinfo: from your distribution package manager:
- Debian: poppler-utils
- Homebrew: poppler

## Installation

Clone this repo locally and run the `pdf2rmnnotebook.sh` script. Optionally, add the script and the `./var` directory somewhere in your `$PATH`.

Optional *nix install:

```
$ sudo cp ./var/lib/pdfrmnotebook /var/lib
```

## Usage

Run the script followed by the list of PDF files, it will create a file that can be sent to the reMarkable using [rmapi](https://github.com/juruen/rmapi)† or [RCU](http://www.davisr.me/projects/rcu/).

**†** rmapi is [deprecated](https://github.com/juruen/rmapi/discussions/313) and no longer supported by the maintainer.

```
pdf2rmnotebook [options] file.pdf [...]

Create multi-page reMarkable Notebook file from PDF files
* Creates .zip files by default for use with rmapi
* Use -r option to create a reMarkable Notebook .rmn file for use with RCU

Options:
Switches (no arguments required):
-h Display this help and exit
-q Produce fewer messages to stdout
-r Create a reMarkable Notebook .rmn file (default: zip)
-v Produce more messages to stdout
-V Display version information and exit

With arguments:
-n NAME Set the rmn Notebook Display Name (default: Notebook-)
Only used with -r option
-o FILE Set the output filename (default: Notebook-.zip)
-s SCALE Set the scale value (default: 0.75) - 0.75 is a good value for A4/Letter PDFs

Example:
pdf2rmnotebook -n "My Notebook" -o mynotebook.zip -s 1.0 file.pdf
```

### Common Recipes:

Create a `.zip` file compatible with rmapi:

`$ $ ./pdf2rmnotebook.sh ./example/2d-3.pdf ./example/3d-1.pdf`

Create a `.rmn` file compatible with RCU:

`$ ./pdf2rmnotebook.sh -r ./example/2d-3.pdf ./example/3d-1.pdf`

Create a `.rmn` file, set the output filename and set the name that will be displayed on the reMarkable:

`$ ./pdf2rmnotebook.sh -r -o combined_shapes -n "Shapes Notebook" ./example/2d-3.pdf ./example/3d-1.pdf`

Create a scaled notebook from a png:
`$ ./pdf2rmnotebook.sh -s 2 ./example/flower.png`

## Thanks

- [drawj2d](https://sourceforge.net/projects/drawj2d/)