deblasis / obsidian-awesome-reader

Make Obsidian a proper Reader.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Awesome Reader

This fork simply patches the next/previous page switch via keyboard shortcuts. I simply removed the event handler, switching page has to be done via the mouse wheel or the buttons on the viewer itself. Now, at least, you won't see your page change just because you are editing another tab inside Obsidian and you press the arrow keys. Full credit to the original author(s). I just wanted to make it usable for me.

Make Obsidian a proper Reader.

Features

  • 💾 Remember reading progress and sync to all devices. You can now continue reading where you left off across all devices.
  • ✒ Create book note from TOC(table of contents). With well organized heading formats.
  • ♳ Support multiple ebook formats. Currently, epub and pdf are supported.

How to use

You may want to toggle on Detect all file extensions first in options -> Files & Links.

  1. Drop some ebooks(e.g. epub files) to your vault. Click it and read.
  2. To create book note, click Open/create book note from file menu. Note will be in the same folder alongside the book.
  3. Reading progress is automatically remembered in plugin's folder. And will be sync to all devices if you got "Obsidian Sync" or similar services.

Known issues

  • Reading progress of pdf format is not fully implemented now

Attribution

Special thanks to caronchen's marvelous Obsidian ePub Reader Plugin, some code is from this great work.

About

Make Obsidian a proper Reader.

License:MIT License


Languages

Language:TypeScript 81.9%Language:JavaScript 15.7%Language:CSS 2.4%