yh-InkLight

by angelwdx
5
4
3
2
1
Score: 44/100

Description

Category: Learning & Knowledge Management

The yh-InkLight plugin provides a shared reading and annotation system for Markdown, PDF and EPUB files. It highlights text in Live Preview and Reading View, attaches comments and returns to the source location. PDF highlights appear as overlays with notes and page navigation, while the bundled foliate-js engine supports EPUB pagination, scrolling, search and display controls. A unified sidebar filters annotations by colour, type and tag, edits comments and exports Markdown summaries with return links. The reading library tracks progress and recent reading, with search, status filters and cover browsing. Generated reading notes synchronise only a marked managed section, leaving handwritten content untouched. Annotations and progress remain separate from source documents in sidecar JSON files and EPUB layout preferences can vary by device.

Reviews

No reviews yet.

Stats

22
stars
4,501
downloads
2
forks
50
days
6
days
6
days
2
total PRs
1
open PRs
0
closed PRs
1
merged PRs
0
total issues
0
open issues
0
closed issues
120
commits

Latest Version

6 days ago

Changelog

新增「墨光设置 → 导出批注 → 批注导出文件夹」。当前文件和全库的 Markdown 批注摘要都支持自定义库内目录;填 / 指定库根,留空保留原默认位置。重复导出仅更新未经修改的同来源、同格式新版摘要;其他同名文件按编号另存。已导出的文件和自动同步阅读笔记不迁移。99 项测试、类型检查及三平台构建通过。

README file from

Github

yh-InkLight

Read and annotate Markdown, PDF, and EPUB in Obsidian. Highlights, notes, tags, and reading progress are stored in separate sidecar JSON files so annotations do not change the original documents.

Requires Obsidian 1.7.2 or later. 中文说明.

Features

  • Markdown annotations: highlight text in Live Preview and Reading View, add comments, and jump back to the source.
  • PDF annotations: display highlights as overlays, attach notes, and navigate to the original page.
  • EPUB reading: read with the bundled foliate-js engine, switch between pagination and scrolling, search within books, and customize fonts, spacing, width, alignment, and themes.
  • Unified annotation sidebar: browse Markdown, PDF, and EPUB annotations together in 40-item pages; search all results, filter by color, type, and visible tag controls; edit comments; and export Markdown summaries.
  • Lighter reading on long documents: reuse text indexes, avoid rebuilding editor highlights on cursor moves, bound visual fuzzy matching, and limit PDF overlays to visible pages without changing source documents.
  • Mobile sidebar: keep the reading source and filters when the drawer closes, use larger touch controls, and adapt to the visible keyboard viewport. Real Android/iOS device validation is still pending.
  • Reading library: browse books and PDFs with search, reading-status filters, progress, recent reading, and a cover grid.
  • Reading notes: link PDFs and ebooks to generated Markdown notes. Annotation changes update only the explicitly managed section and preserve handwritten content outside it.
  • Return to source: exported annotations use obsidian://inklight links to return to the relevant text, PDF page, or EPUB location.
  • Device preferences: desktop, tablet, and phone keep their own EPUB layout preferences. An optional high-contrast e-ink mode applies to the plugin's reading interface.

Installation

Community directory

The plugin has been submitted to the Obsidian Community directory. Availability inside Obsidian depends on its automated review status.

When available, open Settings -> Community plugins -> Browse, search for yh-InkLight, install it, and enable it.

BRAT

  1. Install BRAT.
  2. Add the repository rezonegame/yh-inklight.
  3. Enable yh-InkLight.

Manual installation

  1. Download main.js, manifest.json, and styles.css from the latest GitHub release.
  2. Copy the files into <vault>/.obsidian/plugins/yh-inklight/.
  3. Enable yh-InkLight under Community plugins.

After updating the EPUB engine, fully quit and restart Obsidian to reload its custom elements. To show EPUB files in the file explorer, enable Detect all file extensions under Files and links.

Usage

Select text in a supported reader to highlight it or attach a comment. Open the annotation sidebar to browse, filter, edit, export, or return to annotations. Open the reading library to find books and PDFs in the vault.

To change where Export annotations saves Markdown summaries, set 批注导出文件夹 in the plugin settings. Use a vault-relative folder, enter / for the vault root, or leave it blank to keep the original locations: alongside the source for single-file exports and at the root for vault-wide exports. This setting does not move existing files or change where synchronized reading notes are created.

Use the command palette for highlight, comment, annotation overview, reading library, and reading-note actions. Configure highlight colors, annotation tags, EPUB layout, reading-note folder, and PDF progress under Settings -> yh-InkLight.

Storage and permissions

  • Annotation data and reading progress are stored in <vault>/.obsidian-annotations/ as sidecar JSON files. The plugin reads source documents and scans vault file paths to build its reading library.
  • Generated reading notes and exported summaries are Markdown files inside the vault. Only a generated note's marked managed region is automatically synchronized; handwritten sections are preserved.
  • EPUB layout preferences use device-local localStorage. Cover thumbnails use device-local IndexedDB. These caches are separate from annotation sidecars.
  • Copy actions write selected text or annotation links to the clipboard.
  • The EPUB engine is bundled in the release. No plugin account or subscription is required. Annotation storage does not depend on an external service.

Back up .obsidian-annotations/ together with your vault to preserve annotations. Removing sidecars does not remove the original documents, but does remove the stored annotations and progress.

Development

npm ci
npm run dev
npm run verify
npm run build

npm run verify runs the existing tests, TypeScript checks, and release metadata checks. Test built assets in a separate Obsidian vault.

Optional browser/performance regression instructions are in tests/browser/README.md. They use synthetic documents and test API shims, not a real vault or a mobile-device certification.

Release notes

0.23.9

  • Choose a vault folder for current-file and vault-wide Markdown annotation exports. New folders are created when needed; leaving the setting blank preserves the old destinations.
  • Re-export updates only an unchanged summary generated for the same source and format. Existing notes, edited summaries, and unmarked legacy exports are preserved by choosing a numbered filename.

0.23.8

  • Reduce repeated Markdown text traversal and self-triggered repainting. Add a shared budget only for visual fuzzy fallback; optimize full matching with conservative pruning while preserving legacy match thresholds and search windows.
  • Keep editor decorations on selection/viewport-only updates. Observe only the current native PDF viewer, skip own overlay mutations, reuse page geometry, paint nearby visible pages, and discard stale asynchronous renders.
  • Cache sidebar cards and render 40 per page; keyword/tag filtering still covers the complete result set. Preserve the source document, reject stale results, and clean up Markdown render components per page.
  • Keep tag filtering visible, preserve mobile drawer state, use 44px touch actions, and account for keyboard/short viewports and preferred system text size.
  • 91 automated tests plus isolated Chromium DOM/layout checks. Target environment reports Obsidian 1.14.5; Android/iOS hardware and full native-reader device workflows are not verified. No storage migration or new production dependencies.

0.23.7

  • Move EPUB annotation styles into styles.css, exporting shadow parts so highlight blending and pointer behavior remain correct inside the reader.

0.23.6

  • Address community review errors: preserve workspace leaf positions on unload; render toolbar icons through Obsidian's icon API; use standard settings headings and SVG style helpers; and remove a malformed CSS fragment.
  • Build the annotation undo notice from a DocumentFragment so it does not require a notification API newer than the declared minimum app version.
  • Provide this English README with the full Chinese documentation preserved separately, and correct the author profile link.

0.23.5

  • Use the directory display name yh-InkLight and an English summary.
  • Correct the minimum Obsidian version to 1.7.2. The plugin ID remains yh-inklight.
  • Reading and annotation behavior remains the same as 0.23.4.

See the Chinese documentation and GitHub releases for earlier changes.

License and attribution

MIT. See LICENSE and third-party notices.

  • foliate-js provides the ebook rendering engine.
  • obsidian-pdf-plus informed the adapted PDF text-layer offset implementation described in the third-party notices.
  • Earlier integration work is documented in the Chinese README.

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
PDF++
6 months ago by ryotaushio
PDF++: the most Obsidian-native PDF annotation & viewing tool ever. Comes with optional Vim keybindings.
Markmind
5 years ago by Mark
A mind map, outline for obsidian,It support mobile and desktop
Annotator
5 years ago by Elias Sundqvist
A plugin for reading and annotating PDFs and EPUBs in obsidian.
Pandoc
5 years ago by Oliver Balfour
Pandoc document export plugin for Obsidian (https://obsidian.md)
Image Converter
4 months ago by xryul
⚡️ Convert, compress, resize, annotate, markup, draw, crop, rotate, flip, align images directly in Obsidian. Drag-resize, rename with variables, batch process. WEBP, JPG, PNG, HEIC, TIF.
Obsidian Enhancing Export
5 years ago by YISH
This is an enhancing export plugin base on Pandoc for Obsidian (https://obsidian.md/ ). It's allow you to export to formats like Markdown、Markdown (Hugo https://gohugo.io/ )、Html、docx、Latex etc.
Weread Plugin
4 years ago by hank zhao
Obsidian Weread Plugin is a plugin to sync Weread(微信读书) hightlights and annotations into your Obsidian Vault.
PDF Highlights
6 years ago by Alexis Rondeau
Extract highlights, underlines and annotations from your PDFs into Obsidian
ePub Reader
5 years ago by caronchen
An ePub reader plugin for Obsidian.
Math+
6 months ago by ocapraro
This is an Obsidian plugin for taking math notes using Excalidraw.
Raindrop Highlights
4 years ago by kaiiiz
An Obsidian.md plugin that syncs highlights from Raindrop.
Note Definitions
2 years ago by Dominic Let
Obsidian plugin for seamless viewing of personal definitions
Timestamp Notes
4 years ago by Julian Grunauer
This plugin allows side-by-side notetaking with videos. Annotate your notes with timestamps to directly control the video and remember where each note comes from.
Extract PDF Annotations
5 years ago by Franz Achermann
This is a plugin for https://obsidian.md. It extracts Annotations from PDF Files.
Enhanced Annotations
3 years ago by ycnmhd
Bookshelf
2 years ago by Philip Weinke
Your personal bookshelf in Obsidian
Next TOC
10 months ago by RavenHogWarts
Floating TOC panel
Handwriting
3 months ago by Alan Liu
Pen ink on ordinary Markdown notes in Obsidian.
ibook
4 years ago by bingryan
export mac ibook annotations/hightlights to obsidian vault
Slide Note
4 years ago by Jinyan Xu
Kindle Export
5 years ago by Simeon Stanek
A plugin which converts .md files from Obsidian to your Kindle/PocketBook
Cubox
2 years ago by delphi-2015
Cubox Official Obsidian Plugin
Focus and Highlight
4 years ago by BO YI TSAI
A plugin for obsidian to focus and highlight on a specific heading in Reading mode.
Qiaomu Reader
2 months ago by 向阳乔木
已上架 Obsidian 社区插件市场:搜索 Qiaomu Reader 安装。Read EPUB, PDF and MOBI, highlight passages, keep linked notes and ask optional AI.
Media Slider
2 years ago by Aditya Amatya
An obsidian plugin that helps to make slider for images, audios, videos, pdfs, markdown, etc in obsidian notes.
SideNote
a year ago by mofukuru
Obsidian plugin: Add comment on the part of sentence and refer in comment view.
BibLib
2 years ago by Callum Alpass
Obsidian-based reference and literature note manager.
WuCai highlights Official
4 years ago by 希果壳五彩
WuCai highlights Official, for Sync highlights into your obsidian notes
Plugins Annotations
2 years ago by Andrea Alberti
Obsidian plugin that allows adding personal comments to each installed plugin.
HackerNews
5 years ago by arpitbbhayani
Displays top stories from Hacker News inside Obsidian.
BookFusion
3 years ago by BookFusion
BookFusion Obsidian Plugin
Interlinear Glossing
3 years ago by Mijyuoon
An Obsidian plugin for interlinear glosses used in linguistics texts.
PDF Writer
2 years ago by Jobelin Kom
Obsidian plugin To write and fill a PDF
Air Quotes
3 years ago by Alan Grainger
Plugin for Obsidian. Search and insert quotes from a source text as you type. This is great for reading a physical book or eReader while taking notes on a separate laptop or phone.
PDF Printer
a year ago by cubexy
Obsidian plugin that converts PDF documents to images directly in your notes without external dependencies.
Book Clipper
a year ago by Hossein Fardmohammadi
Save book details from websites into your notes
Third Mind Reader
2 months ago by Rohan Bell
An opinionated EPUB & PDF reader for Obsidian. Read, annotate, and chat with your books. Every highlight stays in your vault as plain markdown, linked back to where it came from. Desktop and mobile, AI optional.
Hardcover
9 months ago by aliceinwaterdeep
Sync your Hardcover.app library to your Obsidian notes.
Readeck Importer
2 years ago by Makebit
Import bookmarks from Readeck to Obsidian
Annotate Audio
2 years ago by VidE
Bible sidecar
2 years ago by Janis Ringli
This repository contains a plugin for obsidian that lets you view the bible in a sidebar within obsidian.
Remember Scrollposition
a year ago by s-blu
A plugin that saves the scroll position for each note to return you to where you left off
PDF++ Exporter
4 months ago by jldiaz
HandLayers
3 months ago by [email protected]
Weread Vault
4 months ago by 茜宁郑
Sync WeRead highlights, import book lists, and connect personal reading notes in Obsidian.
Pick Me
2 months ago by seanishoo
Annotate and ask questions about what you select — in notes and in PDFs — without leaving the page. Annotations live in their own Markdown files; the original document is never modified.
FleurPDF
3 months ago by JC5
Smart PDF reading and annotation plugin for Obsidian with AI-powered features
ICOR for Life - PDF Annotation
2 months ago by Thomas Roedl
Highlight text or draw a box on a PDF and get a note in the vault for it, with a deep link back, a card on any canvas by drag and drop, and a sidebar of every highlight in the open PDF. Part of the ICOR for Life suite.
Remaining reading time
a year ago by ununnamed
Shows the remaining reading time in status bar
Feedly Annotations Sync
2 years ago by Nick Felker
Download my Feedly annotations
FleurEPUB
2 months ago by JC5
Reading progress desktop
a year ago by qian-shen
Obsidian 阅读进度条插件。
ShaahMaat-md
2 years ago by Mihail Kovachev
AIditor
a month ago by Mario Miletta