# yomidevs/yomitan architecture

> Architecture diagram of the GitHub repository yomidevs/yomitan, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yomidevs/yomitan
- Repository: https://github.com/yomidevs/yomitan

## Overview

Yomitan is a browser extension that turns selected or scanned webpage text into dictionary definitions. The principal workflow is page text scanning, language-aware lookup through dictionary workers and databases, then interactive popup rendering. The graph also preserves documented branches for custom search, audio, kanji diagrams, Anki card creation, settings, storage persistence, theming, and accessibility injection. Several subsystem links are inferred from explicit module names and README capabilities; unsampled implementation details are intentionally omitted.

Main entry points: [`ext/js/display/display-content-manager.js`](https://github.com/yomidevs/yomitan/blob/master/ext/js/display/display-content-manager.js) (Display Manager), [`ext/js/app/frontend.js`](https://github.com/yomidevs/yomitan/blob/master/ext/js/app/frontend.js) (Popup Frontend), [`ext/js/background/backend.js`](https://github.com/yomidevs/yomitan/blob/master/ext/js/background/backend.js) (Extension Backend), [`ext/js/dictionary/dictionary-worker.js`](https://github.com/yomidevs/yomitan/blob/master/ext/js/dictionary/dictionary-worker.js) (Dictionary Worker)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interaction["Browser Interaction"]
  node_content_script["Content Script"]
  node_text_scanner["Text Scanner<br/>[text-scanner.js]"]
  node_frontend["Popup Frontend<br/>[frontend.js]"]
end

subgraph group_lookup["Lookup Engine"]
  node_backend["Extension Backend<br/>[backend.js]"]
  node_dictionary_worker["Dictionary Worker"]
  node_language_transformer["Language Transformer"]
  node_dictionary_database[("Dictionary Database")]
  node_search_page["Search Page<br/>[search-main.js]"]
end

subgraph group_presentation["Presentation Features"]
  node_display_manager["Display Manager"]
  node_display_generator["Display Generator"]
  node_structured_content["Structured Content"]
  node_audio_system["Audio System<br/>[audio-system.js]"]
  node_anki_creator["Anki Note Creator"]
  node_anki_renderer["Anki Template Renderer"]
end

subgraph group_configuration["Configuration Integrations"]
  node_settings_controller["Settings Controller"]
  node_persistent_storage["Persistent Storage"]
  node_storage_controller["Storage Controller"]
  node_theme_controller["Theme Controller"]
  node_accessibility_controller["Accessibility Controller"]
  node_script_manager["Script Manager<br/>[script-manager.js]"]
end

node_web_user(("Web User"))
node_web_page["Web Page"]
node_anki_service["AnkiConnect"]
node_browser_storage[("Browser Storage")]
node_browser_scripting["Browser Scripting"]

node_web_user -->|"reads text"| node_web_page
node_web_page -->|"hosts script"| node_content_script
node_content_script -->|"scans text"| node_text_scanner
node_text_scanner -->|"opens lookup"| node_frontend
node_frontend -->|"requests lookup"| node_backend
node_backend -->|"dispatches lookup"| node_dictionary_worker
node_dictionary_worker -->|"transforms text"| node_language_transformer
node_dictionary_worker -->|"reads entries"| node_dictionary_database
node_backend -->|"returns results"| node_frontend
node_frontend -->|"renders results"| node_display_manager
node_display_manager -->|"generates content"| node_display_generator
node_display_generator -->|"builds diagrams"| node_structured_content
node_display_manager -.->|"plays pronunciation"| node_audio_system
node_search_page -->|"requests search"| node_backend
node_display_manager -.->|"creates note data"| node_anki_creator
node_anki_creator -->|"renders template"| node_anki_renderer
node_anki_creator -.->|"sends card"| node_anki_service
node_settings_controller -->|"changes storage"| node_persistent_storage
node_storage_controller -->|"checks persistence"| node_persistent_storage
node_persistent_storage -->|"persists data"| node_browser_storage
node_settings_controller -->|"updates theme"| node_theme_controller
node_accessibility_controller -->|"registers scripts"| node_script_manager
node_script_manager -->|"injects scripts"| node_browser_scripting

click node_content_script "https://github.com/yomidevs/yomitan/blob/master/ext/js/app/content-script-main.js"
click node_text_scanner "https://github.com/yomidevs/yomitan/blob/master/ext/js/language/text-scanner.js"
click node_frontend "https://github.com/yomidevs/yomitan/blob/master/ext/js/app/frontend.js"
click node_backend "https://github.com/yomidevs/yomitan/blob/master/ext/js/background/backend.js"
click node_dictionary_worker "https://github.com/yomidevs/yomitan/blob/master/ext/js/dictionary/dictionary-worker.js"
click node_language_transformer "https://github.com/yomidevs/yomitan/blob/master/ext/js/language/language-transformer.js"
click node_dictionary_database "https://github.com/yomidevs/yomitan/blob/master/ext/js/dictionary/dictionary-database.js"
click node_search_page "https://github.com/yomidevs/yomitan/blob/master/ext/js/display/search-main.js"
click node_display_manager "https://github.com/yomidevs/yomitan/blob/master/ext/js/display/display-content-manager.js"
click node_display_generator "https://github.com/yomidevs/yomitan/blob/master/ext/js/display/display-generator.js"
click node_structured_content "https://github.com/yomidevs/yomitan/blob/master/ext/js/display/structured-content-generator.js"
click node_audio_system "https://github.com/yomidevs/yomitan/blob/master/ext/js/media/audio-system.js"
click node_anki_creator "https://github.com/yomidevs/yomitan/blob/master/ext/js/data/anki-note-data-creator.js"
click node_anki_renderer "https://github.com/yomidevs/yomitan/blob/master/ext/js/templates/anki-template-renderer.js"
click node_settings_controller "https://github.com/yomidevs/yomitan/blob/master/ext/js/pages/settings/settings-controller.js"
click node_persistent_storage "https://github.com/yomidevs/yomitan/blob/master/ext/js/pages/settings/persistent-storage-controller.js"
click node_storage_controller "https://github.com/yomidevs/yomitan/blob/master/ext/js/pages/settings/storage-controller.js"
click node_theme_controller "https://github.com/yomidevs/yomitan/blob/master/ext/js/app/theme-controller.js"
click node_accessibility_controller "https://github.com/yomidevs/yomitan/blob/master/ext/js/accessibility/accessibility-controller.js"
click node_script_manager "https://github.com/yomidevs/yomitan/blob/master/ext/js/background/script-manager.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_content_script,node_text_scanner,node_frontend,node_web_user,node_browser_scripting toneBlue
class node_backend,node_dictionary_worker,node_language_transformer,node_dictionary_database,node_search_page,node_browser_storage toneAmber
class node_display_manager,node_display_generator,node_structured_content,node_audio_system,node_anki_creator,node_anki_renderer toneMint
class node_settings_controller,node_persistent_storage,node_storage_controller,node_theme_controller,node_accessibility_controller,node_script_manager toneRose
class node_web_page,node_anki_service toneIndigo
```

## Components

### Browser Interaction

- [Content Script](https://github.com/yomidevs/yomitan/blob/master/ext/js/app/content-script-main.js): `ext/js/app/content-script-main.js`
- [Text Scanner](https://github.com/yomidevs/yomitan/blob/master/ext/js/language/text-scanner.js): `ext/js/language/text-scanner.js`
- [Popup Frontend](https://github.com/yomidevs/yomitan/blob/master/ext/js/app/frontend.js): `ext/js/app/frontend.js`

### Lookup Engine

- [Extension Backend](https://github.com/yomidevs/yomitan/blob/master/ext/js/background/backend.js): `ext/js/background/backend.js`
- [Dictionary Worker](https://github.com/yomidevs/yomitan/blob/master/ext/js/dictionary/dictionary-worker.js): `ext/js/dictionary/dictionary-worker.js`
- [Language Transformer](https://github.com/yomidevs/yomitan/blob/master/ext/js/language/language-transformer.js): `ext/js/language/language-transformer.js`
- [Dictionary Database](https://github.com/yomidevs/yomitan/blob/master/ext/js/dictionary/dictionary-database.js): `ext/js/dictionary/dictionary-database.js`
- [Search Page](https://github.com/yomidevs/yomitan/blob/master/ext/js/display/search-main.js): `ext/js/display/search-main.js`

### Presentation Features

- [Display Manager](https://github.com/yomidevs/yomitan/blob/master/ext/js/display/display-content-manager.js): `ext/js/display/display-content-manager.js`
- [Display Generator](https://github.com/yomidevs/yomitan/blob/master/ext/js/display/display-generator.js): `ext/js/display/display-generator.js`
- [Structured Content](https://github.com/yomidevs/yomitan/blob/master/ext/js/display/structured-content-generator.js): `ext/js/display/structured-content-generator.js`
- [Audio System](https://github.com/yomidevs/yomitan/blob/master/ext/js/media/audio-system.js): `ext/js/media/audio-system.js`
- [Anki Note Creator](https://github.com/yomidevs/yomitan/blob/master/ext/js/data/anki-note-data-creator.js): `ext/js/data/anki-note-data-creator.js`
- [Anki Template Renderer](https://github.com/yomidevs/yomitan/blob/master/ext/js/templates/anki-template-renderer.js): `ext/js/templates/anki-template-renderer.js`

### Configuration Integrations

- [Settings Controller](https://github.com/yomidevs/yomitan/blob/master/ext/js/pages/settings/settings-controller.js): `ext/js/pages/settings/settings-controller.js`
- [Persistent Storage](https://github.com/yomidevs/yomitan/blob/master/ext/js/pages/settings/persistent-storage-controller.js): `ext/js/pages/settings/persistent-storage-controller.js`
- [Storage Controller](https://github.com/yomidevs/yomitan/blob/master/ext/js/pages/settings/storage-controller.js): `ext/js/pages/settings/storage-controller.js`
- [Theme Controller](https://github.com/yomidevs/yomitan/blob/master/ext/js/app/theme-controller.js): `ext/js/app/theme-controller.js`
- [Accessibility Controller](https://github.com/yomidevs/yomitan/blob/master/ext/js/accessibility/accessibility-controller.js): `ext/js/accessibility/accessibility-controller.js`
- [Script Manager](https://github.com/yomidevs/yomitan/blob/master/ext/js/background/script-manager.js): `ext/js/background/script-manager.js`

### Other components

- **Web User**
- **Web Page**
- **AnkiConnect**
- **Browser Storage**
- **Browser Scripting**

## Connections

- Web User → Web Page: reads text
- Web Page → Content Script: hosts script
- Content Script → Text Scanner: scans text
- Text Scanner → Popup Frontend: opens lookup
- Popup Frontend → Extension Backend: requests lookup
- Extension Backend → Dictionary Worker: dispatches lookup
- Dictionary Worker → Language Transformer: transforms text
- Dictionary Worker → Dictionary Database: reads entries
- Extension Backend → Popup Frontend: returns results
- Popup Frontend → Display Manager: renders results
- Display Manager → Display Generator: generates content
- Display Generator → Structured Content: builds diagrams
- Display Manager → Audio System: plays pronunciation
- Search Page → Extension Backend: requests search
- Display Manager → Anki Note Creator: creates note data
- Anki Note Creator → Anki Template Renderer: renders template
- Anki Note Creator → AnkiConnect: sends card
- Settings Controller → Persistent Storage: changes storage
- Storage Controller → Persistent Storage: checks persistence
- Persistent Storage → Browser Storage: persists data
- Settings Controller → Theme Controller: updates theme
- Accessibility Controller → Script Manager: registers scripts
- Script Manager → Browser Scripting: injects scripts
