Usage

Getting Started

  1. Install the plugin from Community Plugins (or manually copy build artifacts)
  2. Enable the plugin in Settings → Community plugins
  3. Connect to your reMarkable account (see below)

Authentication

Official reMarkable cloud

  1. Run the “Connect to reMarkable cloud” command (Ctrl/Cmd+P → type “Connect”)
  2. In the modal, follow the link to my.remarkable.com/device/desktop/connect
  3. Sign in with your reMarkable account
  4. Copy the 8-character one-time code
  5. Paste it into the plugin modal and click Connect

rmfakecloud

  1. Enable “Use rmfakecloud” in Settings → Community plugins → Remarkable Synchronizer → Cloud
  2. Enter your rmfakecloud server URL (e.g., https://cloud.example.com)
  3. Run the “Connect to reMarkable cloud” command
  4. Open your rmfakecloud web interface and generate a one-time code
  5. Enter the code in the plugin modal and click Connect

Your device token is stored in Obsidian’s secret storage on each device (not in the vault) and persists across sessions. See Configuration for where it lives and what that means if you sync your vault.

Commands

Command Description
Open reMarkable panel Opens the sidebar listing all notebooks
Connect to reMarkable cloud Opens the authentication modal
Disconnect from reMarkable cloud Clears stored tokens
List notebooks Fetches and lists notebooks from the cloud
Sync a notebook Syncs a single notebook chosen from a prompt
Import .rmdoc file Import a local .rmdoc file as images

Using the Panel

The panel shows all your reMarkable notebooks grouped by folder. A connection status indicator at the top shows whether you are connected to the cloud.

Header actions

  • Import (import icon) — import a local .rmdoc file (always available, no cloud connection needed)
  • Sync all (refresh icon with slash) — syncs all notebooks that need updating (have needs-sync or never-synced status)
  • Sync selected — appears when notebooks are selected; syncs only the checked notebooks
  • Refresh (refresh icon) — re-fetches the notebook list from the cloud. Also cleans up sync state for notebooks deleted on your reMarkable (files already in your vault are never deleted).

Searching and filtering

  • Search — a fuzzy search box filters notebooks by name and folder path
  • Filter buttons — toggle between All, Selected, and Unselected to narrow the list
  • Sort — order notebooks within each folder by modified date or name, in either direction. The choice is remembered

Notebook list

Each notebook row shows:

  • Checkbox — select notebooks for bulk sync
  • Sync status dot — colored indicator showing sync state:
    • Synced — local copy is up to date
    • Needs sync — cloud version is newer than the local copy
    • Never synced — notebook has never been synced locally
  • Notebook name and last-modified date
  • Sync button — syncs that individual notebook

A Select all checkbox at the top operates on the currently filtered notebooks.

Progress is shown inline per notebook: downloading → parsing → rendering → done. If any page fails to render, the done state shows a warning (“Done — N pages failed to render”) and the completion notice reports how many pages were processed successfully; failed pages do not count as synced.

Importing .rmdoc Files

You can import .rmdoc files exported from a reMarkable tablet without needing a cloud connection. This is useful for processing files shared by others or exported manually.

On iPhone and iPad, the system file picker may not offer .rmdoc files for selection. Cloud sync is unaffected. Please report it if you hit this.

  1. Run the “Import .rmdoc file” command (Ctrl/Cmd+P → type “Import”), or click the import button in the panel header
  2. Select a .rmdoc file from your file system
  3. Review the file name and target folder in the confirmation dialog
  4. Click Import to process the file

The notebook name is taken from the document metadata if available, otherwise from the file name. Images are saved to the configured target folder (not grouped by folder hierarchy).

Output

Files are saved to your configured target folder (default: vault root), preserving the reMarkable folder hierarchy for cloud-synced notebooks. Imported .rmdoc files are saved directly under the target folder.

Each page with content produces an image file:

  • {NotebookName}-P{NNN}.{ext} — rendered page image (if “Save images” is enabled)

The file extension matches your configured image format (.jpeg by default, or .png/.webp).

If Save as PDF is enabled, the notebook also produces:

  • {NotebookName}.pdf — every page with content, in one file, beside the image folder

If Save typed text note is enabled, any document with keyboard-typed text also produces:

  • {Name} (text).md — that text as a searchable markdown note. Handwriting is not included; it stays as ink in the page image

For a document imported from a PDF, you always get the original plus an annotated copy instead, whether Save as PDF is on or not:

  • {Name}.pdf — the original document, unchanged
  • {Name} (annotated).pdf — the same document with your handwriting drawn on top, text still selectable
  • {Name} (highlights).md — a note quoting any text you highlighted, when Save highlights note is enabled

A document imported from an EPUB is written through as {Name}.epub, unchanged and unannotated.

Blank pages are skipped entirely. A page is blank only when it has no handwriting, no typed text, no highlight and no placed image (dragged in from the desktop app on reMarkable OS 3.27, or made with the 3.28 capture tool). Skipping means PDF page numbers do not necessarily match the page numbers on your device. Pages that fail to render are skipped too, and the plugin reports how many.

Generated files are overwritten

Every path listed above belongs to the plugin. When a notebook syncs, the plugin compares what it just generated against what is already in your vault, and writes only when the two differ.

That comparison is on file contents, not on timestamps. Anything that touches a file without changing it, another sync tool, a backup job, opening it, or a plain touch, is harmless. The plugin does not read file modification times at all and will not react to one changing.

Changing the contents is different. If you annotate a generated PDF inside Obsidian, or edit a generated note, the next sync of that notebook sees different bytes and replaces the file with a fresh copy. Your edits are lost, without a prompt.

So treat these files as output rather than as documents you own:

  • To annotate a document, do it on the reMarkable. Your handwriting comes back in {Name} (annotated).pdf on the next sync.
  • To keep an edited version, rename it first. A renamed file no longer sits at a path the plugin writes to, so it is left alone permanently, and renaming from inside Obsidian rewrites any links pointing at it. Expect the plugin to recreate the original file at its old path on the next sync, so you end up with both.
  • To write your own notes about a notebook, put them in a separate note and link to the generated one.