mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
sudacode
9e6d039a32
Remove configurable isLapis sentence/audio field overrides so sentence cards always map to Sentence and SentenceAudio. Update types and docs to reflect the simplified config surface.
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), mpv plugin, keybindings - Mining Workflow — End-to-end sentence mining guide, overlay layers, card creation
Reference
- Configuration — Full config file reference and option details
- Immersion Tracking — SQLite schema, retention/rollup policies, query templates, and extension points
- Anki Integration — AnkiConnect setup, field mapping, media generation, field grouping
- Jellyfin Integration — Optional Jellyfin auth, cast discovery, remote control, and playback launch
- 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