Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Note Reader

A text-to-speech plugin with multiple voice service options and text highlighting features.

Features

  • Multiple voice service options:
    • System native voices
    • Eleven Labs AI voices
    • OpenAI TTS voices
  • Interactive playback controls
  • Text highlighting during playback:
    • Paragraph highlighting
    • Sentence highlighting
    • Word highlighting
  • Customizable playback settings:
    • Voice selection
    • Playback speed
    • Volume control
  • Keyboard shortcuts for navigation
  • Beautiful and intuitive UI

Installation

  1. Open Obsidian Settings
  2. Go to Community Plugins and disable Safe Mode
  3. Click Browse and search for "Reader"
  4. Install the plugin and enable it

Usage

alt text

  1. Click the speaker icon in the ribbon menu or use the command palette to start reading
  2. Use the playback controls in the status bar to:
    • Play/Pause
    • Skip to next/previous paragraph
  3. Configure voice and highlighting options in the plugin settings

Configuration

Voice Services

  • System Native: Uses your operating system's built-in voices
  • Eleven Labs: High-quality AI voices (requires API key)
  • OpenAI: Advanced TTS voices (requires API key)

Highlighting Options

  • Enable/disable text highlighting
  • Choose highlight styles:
    • Background color
    • Underline
    • Box around text
  • Customize colors for:
    • Paragraphs
    • Sentences
    • Words

Development

  • Clone this repository
  • npm install to install dependencies
  • npm run dev to start compilation in watch mode

Support

Found a bug or have a feature request? Please report it on GitHub: Create an issue

About

No description or website provided.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages