Skip to content

Terafora/Yomisaver-Free

Repository files navigation

YomiSaver

YomiSaverProgress003

YomiSaver is a Chrome extension designed to help you learn Japanese effortlessly by adding furigana (reading aids) to web pages, building vocabulary lists, and exporting Anki-compatible flashcards.

Features

  • Furigana Injection: Automatically adds furigana to Japanese text on web pages using the Kuromoji tokenizer
  • Interactive Popups:
    • Hover over Japanese text to see definitions
    • Auto-positioning to stay within viewport
    • Auto-closes after 3 seconds unless hovered
    • Shows JLPT level when available
    • Displays word readings and meanings
  • Vocabulary Saving:
    • Save words via context menu
    • Automatic saving when viewing definitions
    • Prevents duplicate entries
  • Clean Display:
    • Removes furigana from popup displays
    • Properly formats meanings with parts of speech
    • Shows grammatical tags and additional info

Installation/ Tutorial

  1. Clone or download this repository
  2. Open Chrome and navigate to chrome://extensions/
  3. Enable "Developer mode" in the top right corner
  4. Click "Load unpacked" and select the directory containing this project and delect the dist folder

and if you're forking this repo to develop

  1. Run npm install to install dependencies
  2. Run npm run build to build the extension

Visual tutorial available on my website. Click here!

Usage

  1. View Word Definitions:

    • Hover over any Japanese text to see its definition
    • Popups position themselves intelligently to stay visible
    • Move mouse to popup to keep it open
    • Press ESC to dismiss popup
  2. Save Vocabulary:

    • Right-click on text and choose "Save Word to Flashcards"
    • Words are automatically saved when viewing definitions
    • View saved words in extension popup

Project Structure

  • background.js: Handles API requests and vocabulary storage
  • content.js: Manages furigana injection and popup interactions
  • manifest.json: Extension configuration
  • styles.css: Popup and furigana styling
  • popup.html/js: Vocabulary list viewer
  • webpack.config.js: Build configuration

Dependencies

  • kuromoji: Japanese text tokenizer
  • Webpack for building
  • Chrome Extension APIs

Current Progress

  • Furigana injection working
  • Hover popups implemented
  • Smart popup positioning
  • Auto-close behavior
  • Clean text display
  • Anki export support
  • Options menu

Known Issues

Data Attribution

The Japanese dictionary data is provided by Jisho.org's API. Jisho.org is a powerful Japanese-English dictionary that provides word definitions, readings, and JLPT levels. It uses the EDICT/JMdict dictionary files from the Electronic Dictionary Research and Development Group under the Creative Commons Attribution-ShareAlike License (CC BY-SA 3.0).

About

This is YomiSaver, a Japanese language learning extension.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published