README file from
GithubGlasp for Obsidian
Import your Glasp highlights and notes — from the web and from Kindle — directly into your Obsidian vault, and keep them in sync automatically.
Glasp is a social web highlighter that lets you highlight and take notes on the web, PDFs, YouTube, and Kindle, then own and export everything you collect. This plugin brings that knowledge into Obsidian as Markdown notes you fully control.
✨ Features
- 📥 Import web highlights & notes from Glasp into a folder of your choice.
- 📚 Import Kindle highlights & notes (new in v0.2.0) into a separate folder, so book highlights stay out of your web notes.
- 🔁 Automatic background sync — every hour, every day, or once a week.
- ➕ Incremental & non-destructive — only new/updated highlights are fetched, and existing notes are matched by source URL and updated in place (no duplicates).
- 🎨 Customizable templates — define your own Markdown layout and frontmatter for web and Kindle notes, or use the sensible defaults.
- 📱 Desktop & mobile — works anywhere Obsidian runs.
📦 Installation
From Obsidian Community Plugins (recommended)
- Open Settings → Community plugins in Obsidian.
- Search for “Glasp”, click Install, then Enable.
Manual
- Download
main.jsandmanifest.jsonfrom the latest release. - Copy them into
[YourVault]/.obsidian/plugins/glasp/. - Reload Obsidian and enable Glasp under Community plugins.
🚀 Getting started
📺 Prefer a walkthrough? Follow the full step-by-step tutorial on exporting Glasp highlights into Obsidian.
- Get your access token from your Glasp account: https://glasp.co/settings/access_token
- 💡 If the link opens inside Obsidian and you can’t sign in, use the copy button next to the token field and paste the URL into your default browser (Chrome, Safari, etc.).
- In Settings → Glasp, paste the Access token.
- Choose an output folder for web highlights and/or an output folder for Kindle highlights.
- Leaving a folder unset simply skips that source — enable web, Kindle, or both.
- Pick an update frequency. Your highlights are imported on startup and then on that schedule. You can also trigger an import any time via the ribbon icon or the command palette (“Glasp: Import highlights”).
⚙️ Settings
| Setting | Description |
|---|---|
| Access token | Your Glasp API token. Stored locally in your vault and sent only to api.glasp.co. |
| Web highlights output folder | Where web highlight notes are saved. Unset = skip web import. |
| Kindle highlights output folder | Where Kindle highlight notes are saved. Unset = skip Kindle import. |
| Web / Kindle highlights template | Custom note layout (see below). Empty = default template. |
| Update frequency | How often highlights are synced automatically (hourly / daily / weekly). |
🎨 Customizing the template
You can fully control how each note looks using Handlebars placeholders. Leave a template empty to use the default.
Web highlights — available variables:
{{url}} · {{glasp_url}} · {{tags}} · {{updated_at}} · {{content}}
Kindle highlights — available variables:
{{url}} · {{glasp_url}} · {{author}} · {{tags}} · {{updated_at}} · {{content}}
---
URL: {{url}}
Glasp URL: {{glasp_url}}
Tags: [{{tags}}]
Last updated: {{updated_at}}
---
{{content}}
---
URL: {{url}}
Glasp URL: {{glasp_url}}
Author: {{author}}
Tags: [{{tags}}]
Last updated: {{updated_at}}
---
{{content}}
🔒 Privacy & security
- Your access token is stored locally in your vault (
.obsidian/plugins/glasp/data.json) and is used only to call the official Glasp API athttps://api.glasp.co. - The plugin has read-only access to your own highlights. It never sends your notes anywhere.
- ⚠️ If you sync or share your vault, be aware that
data.jsoncontains your token — treat it like a password.
🛠️ Development
git clone https://github.com/glasp-co/obsidian-glasp-plugin
cd obsidian-glasp-plugin
npm install
npm run dev # watch & rebuild
npm test # run unit tests
npm run build # production build
To develop against a live vault, clone into [YourVault]/.obsidian/plugins/ and run npm run dev.
🐞 Bugs & feedback
Found a bug or have a feature request? Please open an issue.
🔗 Links
- 🌐 Glasp — highlight & organize what you read
- 📖 Glasp API documentation
- 📺 Tutorial: Export highlights into Obsidian
- 🔑 Get your access token
- 🧩 Obsidian