https://github.com/seryiza/remplater

generated pdf templates for remarkable 2 from code
https://github.com/seryiza/remplater

clojure pdf-template pdfbox remarkable

Last synced: about 2 months ago
JSON representation

generated pdf templates for remarkable 2 from code

• Host: GitHub
• URL: https://github.com/seryiza/remplater
• Owner: Seryiza
• License: gpl-3.0
• Created: 2024-10-27T02:56:34.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2024-11-12T15:01:49.000Z (about 2 months ago)
• Last Synced: 2024-11-12T16:18:15.346Z (about 2 months ago)
• Topics: clojure, pdf-template, pdfbox, remarkable
• Language: Clojure
• Homepage:
• Size: 10.3 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CI](https://github.com/Seryiza/remplater/actions/workflows/ci.yml/badge.svg)](https://github.com/Seryiza/remplater/actions/workflows/ci.yml)

# Remplater

My PDF templates and code to generate them targeted Remarkable 2.

Feel free to [download](https://github.com/Seryiza/remplater/releases) and generate PDFs, create your templates via clojure, and suggest ideas for new templates in [issues](https://github.com/Seryiza/remplater/issues).

### Templates

#### Remarkable-Calendar

inspired by [elainajones](https://github.com/elainajones/remarkable-calendar) ⨯ Hobonichi Techo

  Template Details

  I love this cool and minimalistic template. I reimplemented it to ensure that this project has enough features.

  Options:

  - `--start-date`: start date (format `YYYY-MM-DD`)

  - `--end-date`: end date (format `YYYY-MM-DD`)

  - `--timeline-labels`: timeline labels (format `rowindex1:label1,rowindex2:label2`)

  Code Location:

  ```

src/remplater/templates/remarkable_calendar.clj

```

  

  Example CLI Command:

  ```bash

java -jar target/remplater.jar generate remarkable-calendar --start-date=2024-01-01 --end-date=2025-01-31 --filename this.pdf --timeline-labels=12:17

```

| Monthly View | Daily View |

| ------------ | ---------- |

| ![Montly View](.github/images/remarkable_calendar_monthly.png) | ![Montly View](.github/images/remarkable_calendar_daily.png) |

## How to download PDFs

You can download already generated PDF files from [releases](https://github.com/Seryiza/remplater/releases).

Also, there's [the Development Prerelease](https://github.com/Seryiza/remplater/releases/tag/latest) with the latest code changes. You can use it too, but it's unstable.

## How to generate PDFs

Requirements: Java

You can generate PDF templates for custom date ranges and some customization. Download and run the latest jar file from [releases](https://github.com/Seryiza/remplater/releases).

For example:

```bash

java -jar remplater.jar generate remarkable-calendar --start-date=2024-01-01 --end-date=2025-01-31 --filename this.pdf --timeline-labels=12:17

```

You can get help and display all options:

```

$ java -jar remplater.jar

Remplater: Remarkable Templater.

Usage:

  remplater generate remarkable-calendar [options] --start-date=<2024-01-01> --end-date=<2025-01-31> [--timeline-labels=<0:12,10:18>]

  remplater --help

  remplater --version

Options:

  --help                  Show this screen

  --version               Show version

  --filename=   Output filename

```

## How to develop this project

Requirements: Java, Clojure

Just start REPL as usual. For the introduction in the codebase, you can read [existing templates](https://github.com/Seryiza/remplater/blob/master/src/remplater/templates/remarkable_calendar.clj).

Remplater has automated tests. You can run them inside your editor or command `make test`.

You can build a jar file via the command `make uberjar`.