Files
SubMiner/docs
sudacode 3a27c026b6 feat: integrate n+1 target highlighting
- Merge feature branch changes for n+1 target-only highlight flow

- Extend merged token model and token-merger to mark exactly-one unknown targets

- Thread n+1 candidate metadata through tokenizer and config systems

- Update subtitle renderer/state to route configured colors and new token class

- Resolve merge conflicts in core service tests, including subtitle and subsync behavior
2026-02-15 02:36:48 -08:00
..
2026-02-15 02:29:41 -08:00
2026-02-15 02:29:41 -08:00
2026-02-15 02:29:41 -08:00
2026-02-15 02:29:41 -08:00
2026-02-15 02:29:41 -08:00
2026-02-14 00:36:01 -08:00
2026-02-14 00:36:01 -08:00

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
  • Usagesubminer wrapper, 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