Skip to content

tu2-atmanand/obsidian-library-plugin

 
 

Repository files navigation

Library - plugin for Obsidian

Forked from PDF++ by RyotaUshio.

This project is to create a plugin to have an in-built library management system and a speech reader inside Obsidian. The ideas and motivation for this plugin originated from the following discussions on Obsidian Forum :

Important

I forked the PDF++ project to give a head start for this plugin development, since the PDF++ plugin has the best features in terms of Annotations, highlighting and taking notes from PDF files. And also because the project license supports free use, modification and publishing of the software. Read more about all the features from the PDF++ Readme. After all the planned tasks has been achieve for a proper integration of this plugin with PDF++, all the PDF++ related features will be removed from this plugin and users will be requested to install PDF++ to get all the annotations functionalities. Similarly, all the bug reports and feature reports should be done on the PDF++ Issues section.

Roadmap for the plugin development

Following are the features planned for this plugin :

Home Page :

A rough plugin UI blueprint

  • A custom plugin view to see all the integrated sources, recently read books, recent highlights, etc.
  • The plugin homescreen will have features to search and sort books, based on date, updated, author, genre, etc.
  • Each book/article/audiobook will be shown as cards with thumbnail. The card will have a progress bar, link to PDF and a button to link to the markdown file for taking notes for the specific file.
  • Functionality to create collection, to manually organize your books in virtual folders, whereas the source of the book can be from any location.

Speech Reader :

The following features should be integrated along with the current features of the PDF++ plugin. So, user can listen to the documents like pdf/epubs effortlessly as well as annotate them on the go.

SpeechReaderControls

  • A controller bar (horizontal or vertical), for controlling features such as, voice speed, volume, different types of voices.
  • The voices can be either from the offline ones or can be used from the free online APIs.
  • The current spoken words will be highlighted, and the page should be auto-scrolled.
  • The user should be able to pause and continue back from the same checkpoint from the last session. Hence, the checkpoint should be stored from the PDF or any other file.

About

Use this project as reference to create the Audiobook, speed reader plugin (Library).

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.7%
  • CSS 1.8%
  • Other 0.5%