Skip to content

LuisReinoso/obsidian-speed-reading

Repository files navigation

Obsidian Speed Reading Plugin

Part of the Study Framework — a small ecosystem of tools for evidence-based learning in Obsidian. Each piece is independent and usable on its own.

Component Role
obsidian-speed-reading (this repo) RSVP reader with retrieval practice, streaks, and session tracking
obsidian-study-spaced-repetition Spaced repetition flashcard review using question::answer notes (fork of st3v3nmw/obsidian-spaced-repetition)
obsidian-study-quiz In-note quiz UI powered by a self-hosted Claude backend (fork of ECuiDev/obsidian-quiz-generator)
claude-study-server Backend that generates the summaries, flashcards, and quiz questions consumed by the three plugins

A plugin to enable speed reading using the RSVP (Rapid Serial Visual Presentation) technique. Select text in your note and trigger a modal to display words at a user-controlled pace.

Speed Reading Demo

Features

  • Command palette entry: Speed Read Selected Text
  • Configurable hotkey trigger
  • Modal dialog with RSVP display
  • Start/Pause button
  • Adjustable WPM (words per minute) control
  • Close button
  • Robust Markdown handling for clean reading experience
  • Settings tab for default WPM and preferences
  • User-configurable progress bar control
  • Full mobile support

Installation

  1. Build the plugin
    In your project directory, run:

    pnpm install
    pnpm run build
    
  2. Copy plugin files
    Copy the following files and folders to your Obsidian vault’s plugins directory (e.g., YourVault/.obsidian/plugins/speed-reading):

    • manifest.json
    • styles.css
    • dist/main.js
    • (For compatibility, also copy dist/main.js as main.js in the plugin root)
  3. Enable the plugin

    • Open Obsidian.
    • Go to SettingsCommunity pluginsInstalled plugins.
    • Enable Speed Reading.

Usage

  1. Open a note and select the text you want to speed read.
  2. Open the command palette (Ctrl+P or Cmd+P), search for Speed Read Selected Text, and run the command.
  3. The RSVP modal will appear. Use the Start/Pause button and adjust WPM as needed.

Development Notes

  • Built with TypeScript and the Obsidian API.

Future Enhancements

  • Public release preparation (code review, linting, versioning, submission to community plugins)

About

RSVP speed reader for Obsidian with retrieval practice, streaks, and AI study integration. Part of the Study Framework.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors