mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
sudacode
a359e91b14
Standardize core service module and export names to reduce naming ambiguity and make imports predictable across runtime, tests, scripts, and docs.
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, mpv plugin, keybindings, YouTube playback - Mining Workflow — End-to-end sentence mining guide, overlay layers, card creation
Reference
- Configuration — Full config file reference and option details
- Anki Integration — AnkiConnect setup, field mapping, media generation, field grouping
- 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