RapidInk

Bullet journal planner generator for e-ink devices
GitHub

RapidInk Documentation

RapidInk is a customizable bullet journal PDF generator optimized for e-ink devices. This guide covers all features and workflows.

Getting Started

RapidInk runs entirely in your browser - no account or server required. Your settings are embedded in the generated PDF, so you can import it later to restore your configuration.

Basic Workflow

  1. Select your device - Choose a preset or enter custom dimensions
  2. Configure your journal - Enable/disable sections, set preferences
  3. Generate PDF - Click "Generate PDF" and wait for processing
  4. Transfer to device - Upload via USB, cloud sync, or email

Importing Previous Settings

If you have a previously generated RapidInk PDF, click "Import Template" to restore your settings. This also enables handwriting preservation if the PDF contains annotations.

Device Presets

RapidInk includes optimized presets for popular e-ink devices. Each preset configures the page dimensions and toolbar position for optimal use.

Supported Devices

DeviceDimensionsNotes
reMarkable Paper Pro1620 × 2160 pxLeft toolbar, optimized contrast
reMarkable 21404 × 1872 pxLeft toolbar
Supernote A5X1404 × 1872 pxRight toolbar
Kindle Scribe1860 × 2480 pxRight toolbar
iPad (GoodNotes)VariousStandard PDF dimensions

Custom Dimensions

Select "Custom" to enter your own page dimensions. Useful for print or unsupported devices.

Page Options

Enable or disable sections to customize your journal structure.

Available Sections

Cover Page
A title page with the year. Good for visual organization.
Index
Table of contents with links to all sections. Essential for navigation.
Guide Page
Quick reference for bullet journal notation and symbols.
Intention Page
Set your yearly theme, word, or intention.
Goals Page
Track yearly goals and objectives.
Future Log
Quarterly overview for long-term planning. 4 pages covering the full year.

Monthly Pages

Each month includes two page types:

Monthly Timeline

A vertical list of all days in the month with space for events and tasks. Holidays are automatically included based on your country/region selection. Custom codes appear inline with their scheduled days.

Monthly Notes

A blank page (with your chosen background pattern) for monthly reflection, goals, or overflow notes.

Holiday Configuration

Select your country to automatically include national holidays on the timeline. Some countries support state/region selection for local holidays.

Weekly Pages

Weekly spreads show all 7 days with space for tasks and events. Each day links to its daily page for quick navigation.

Layout Options

  • Week starts on - Monday or Sunday
  • Include custom codes - Scheduled codes appear in rapid log format

Daily Pages

Individual pages for each day with the date header and your chosen background pattern. Custom codes scheduled for the day appear at the top.

Navigation

Daily pages include links back to the weekly spread and monthly timeline for easy navigation.

Habit Tracker

A monthly grid for tracking habits. Each row is a habit, each column is a day. Tap to mark habits as complete.

Configuring Habits

  1. Enable "Habit Tracker" in Page Options
  2. Open the Habits section in the accordion
  3. Add, remove, or rename habits as needed
  4. Drag to reorder habits

Default habits include Exercise, Water, Reading, Sleep, and Meditation. Customize to match your tracking needs.

Custom Codes

Define short codes for recurring events or tasks that auto-populate on your calendar. Perfect for garbage day, appointments, or any repeating item.

Creating a Custom Code

  1. Open the Custom Codes section
  2. Click "Add Code"
  3. Enter a short code (1-4 characters, e.g., "G" for Garbage)
  4. Add a description
  5. Choose Task (bullet point) or Event (circle)
  6. Set frequency (Weekly or Biweekly)
  7. Pick a start date to anchor the schedule
  8. Set span days (1 for single day, more for multi-day events)

Where Codes Appear

  • Monthly Timeline - Codes appear inline after the day, with a key at the bottom
  • Weekly Pages - Codes appear in rapid log format with date links
  • Daily Pages - Codes appear as bullet items at the top

Example: Biweekly Garbage Collection

Code: G, Description: "Garbage", Frequency: Biweekly, Start Date: First pickup day, Span: 1 day

Collections

Collections are custom sections for lists, notes, or any content that doesn't fit the daily/weekly/monthly structure. Classic bullet journal collections include book lists, project notes, and brainstorms.

Creating Collections

  1. Enable "Collections" in Page Options
  2. Open the Collections section
  3. Click "Add Collection"
  4. Name your collection and set page count
  5. Choose a template (dots, lines, grid, checklist, or blank)

PDF Template Import

You can import a PDF as a collection template. Click the upload icon next to the template dropdown and select a PDF. The first page will be used as the background for all pages in that collection.

Collection Index

When collections are enabled, a Collection Index page is added with links to each collection. Write-in slots let you add collections by hand later.

Visual Settings

Customize the appearance of your journal.

Page Background

  • Dot Grid - Classic bullet journal style
  • Square Grid - Graph paper for diagrams
  • Ruled Lines - Traditional notebook
  • Blank - No background pattern

Spacing and Size

  • Dot Spacing - Distance between dots/lines in mm
  • Dot Size - Size of dots in pixels
  • Dot Opacity - Visibility of background pattern

Typography

  • Font - Helvetica, Times, or Courier
  • Font Size - Base text size
  • Text Color - Color for headings and labels
  • Line Color - Color for dots, lines, and borders

Template Upgrade

When you've been using a RapidInk journal and want to make changes (new year, different settings), you can preserve your handwriting while regenerating the template.

How It Works

  1. Export your annotated PDF from your e-ink device
  2. Click "Import Template" and select the PDF
  3. RapidInk extracts your settings and detects handwriting
  4. Adjust settings as needed (year, new sections, etc.)
  5. Generate the new PDF
  6. Handwriting is placed on matching pages (same dates, same collections)

Limitations

  • Handwriting becomes static (can't be selected/erased on device)
  • Only pages with matching anchors get handwriting transferred
  • If you remove a page type, that handwriting is lost

For editable handwriting preservation, see Notes Preservation.

Notes Preservation (Advanced)

This advanced feature preserves your handwriting as editable strokes by working directly with your reMarkable's native file format. Unlike template upgrade, your handwriting remains selectable and erasable.

Requirements:
  • reMarkable with Developer Mode enabled (requires factory reset)
  • SSH access to your device
  • Basic command line familiarity
  • sshpass installed (sudo apt install sshpass)

Enabling Developer Mode

  1. Ensure all documents are synced to reMarkable Cloud
  2. On device: Settings → General → Paper Tablet → Software → Advanced → Developer Mode
  3. Device will factory reset and restart
  4. Log back in - your documents sync from cloud
  5. Find your SSH password: Settings → General → Paper Tablet → About → Copyrights → GPLv3

Finding Your Document

Documents are stored in /home/root/.local/share/remarkable/xochitl/

Each document is a folder named with a UUID. To find yours:

ssh root@10.11.99.1  # Connect via USB
grep -r "Your Document Name" /home/root/.local/share/remarkable/xochitl/*.metadata

Notes Preservation Workflow

  1. Download from device:
    scp -r root@10.11.99.1:/home/root/.local/share/remarkable/xochitl/YOUR-UUID ./my-journal
  2. ZIP the folder:
    cd my-journal && zip -r ../my-journal.zip . && cd ..

    Important: ZIP from inside the folder so files are at the root of the archive.

  3. Upload to RapidInk - Use the Notes Preservation wizard
  4. Configure your new template - Adjust year, settings, etc.
  5. Download the result ZIP
  6. Upload to device using the script:
    export REMARKABLE_PASSWORD='your-ssh-password'
    ./scripts/upload-to-remarkable.sh ~/Downloads/remarkable-document.zip

    The script extracts the ZIP directly to the device and restarts the UI automatically.

How Page Mapping Works

RapidInk maps handwriting from old pages to new pages using anchors - unique identifiers embedded in each page (e.g., day-2026-01-15, week-3-action).

  • Pages with matching anchors have their strokes transferred
  • If you change the year from 2025 to 2026, Jan 15 strokes move to the new Jan 15 page
  • Notes pages, collections, and other sections are also mapped by anchor
  • Pages added manually on the device (not in the original template) cannot be migrated

Limitations

  • Pages added on the device itself cannot be migrated (no anchor exists)
  • If you remove a page type (e.g., disable weekly pages), that handwriting is lost
  • The upload script requires sshpass to be installed

Alternative Tools

If you prefer a GUI, ReMy provides graphical file browsing over SSH.