mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
sudacode
ebec472daf
Split config defaults, option metadata, runtime-option registry, and template sections into domain modules while preserving the composed public API in definitions.ts. This keeps ConfigService behavior stable and makes future config extensions easier to add with focused regression coverage.
Documentation
SubMiner documentation is built with VitePress.
Local Docs Site
make docs-dev # Dev server at http://localhost:5173
make docs # Build static output
make docs-preview # Preview built site at http://localhost:4173
Pages
Getting Started
- Installation — Requirements, Linux/macOS/Windows install, mpv plugin setup
- Usage —
subminerwrapper + subcommands (jellyfin,yt,doctor,config,mpv,texthooker,app), mpv plugin, keybindings - Mining Workflow — End-to-end sentence mining guide, overlay layers, card creation
Reference
- Configuration — Full config file reference and option details
- Keyboard Shortcuts — All global, overlay, mining, and plugin chord shortcuts in one place
- Anki Integration — AnkiConnect setup, field mapping, media generation, field grouping
- Jellyfin Integration — Optional Jellyfin auth, cast discovery, remote control, and playback launch
- Immersion Tracking — SQLite schema, retention/rollup policies, query templates, and extension points
- JLPT Vocabulary — Bundled term-meta bank for JLPT level underlining and frequency highlighting
- MPV Plugin — Chord keybindings, subminer.conf options, script messages
- Troubleshooting — Common issues and solutions by category
Development
- Building & Testing — Build commands, test suites, contributor notes, environment variables
- Architecture — Service-oriented design, composition model, renderer module layout