Luminaria Highlights

unlisted

by James Langton

Sync your e-reader highlights to your vault. Requires a Luminaria subscription.

Updated 1mo agoMIT
View on GitHub

Luminaria Highlights — Obsidian Plugin

Sync your Kobo and KOReader reading highlights from Luminaria directly into your Obsidian vault. One markdown file per book, with YAML frontmatter, chapter headings, and highlights sorted by date.

Requirements

This plugin requires either:

  • A Luminaria subscription (£2.99/month) — includes auto-sync, PDF export, Notion export, and this Obsidian plugin, or
  • A Luminaria lifetime access pass (coming soon)

You also need a free Luminaria token from luminaria.uk/signup — your token is how the plugin authenticates with your account.

Without a paid subscription the plugin will connect but show an error prompting you to upgrade.

Features

  • Sync all your highlights into a dedicated vault folder
  • One .md file per book with YAML frontmatter (title, author, tags, sync date)
  • Highlights grouped by chapter and sorted by date highlighted
  • Manual sync via ribbon button or command palette
  • Optional automatic sync on Obsidian startup
  • Updates existing files on re-sync — no duplicates

Installation

Via BRAT (recommended while awaiting community plugin approval)

BRAT is a community plugin that lets you install Obsidian plugins directly from GitHub.

  1. Install BRAT from the Obsidian community plugins directory
  2. Open BRAT settings → click Add Beta Plugin
  3. Paste: https://github.com/jamesisonfire21-glitch/luminaria-highlights
  4. Click Add Plugin
  5. Go to Settings → Community plugins → enable Luminaria Highlights

Manual

  1. Download main.js and manifest.json from the latest release
  2. Create a folder: <your-vault>/.obsidian/plugins/luminaria-highlights/
  3. Copy both files into that folder
  4. Open Obsidian → Settings → Community plugins → enable Luminaria Highlights

From the Community Plugin Directory (coming soon)

Search for "Luminaria" in Settings → Community plugins → Browse.

Setup

  1. Get a free token at luminaria.uk/signup
  2. Subscribe at luminaria.uk/upgrade
  3. Go to Settings → Luminaria Highlights
  4. Paste your token
  5. Set the vault folder name (default: Luminaria)
  6. Optionally enable Sync on startup
  7. Click Sync highlights or use the ribbon button

Output format

Each book creates a file like Luminaria/Meditations.md:

---
title: "Meditations"
author: "Marcus Aurelius"
tags: [highlights, luminaria]
synced: 2026-04-16
---

*Marcus Aurelius*

## Book Two

> You have power over your mind, not outside events.

*p.42 · 14 January 2025*

Development

npm install
npm run dev   # watch mode
npm run build # production build

Privacy

Your highlights are fetched directly from the Luminaria Worker using your personal token. Nothing is sent to any third party.

Links

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.