Files
SubMiner/docs/index.md
sudacode 781e6dd4fa docs: overhaul documentation and add four new pages
- Add mining-workflow.md: end-to-end sentence mining guide
- Add anki-integration.md: AnkiConnect setup, field mapping, media generation, field grouping
- Add mpv-plugin.md: chord keybindings, subminer.conf options, script messages
- Add troubleshooting.md: common issues and solutions by category
- Rewrite architecture.md to reflect current ~1,400-line main.ts and ~35 services
- Expand development.md from ~25 lines to full dev guide
- Fix URLs to ksyasuda/SubMiner, version to v0.1.0, AppImage naming
- Update VitePress sidebar with three-group layout (Getting Started, Reference, Development)
- Update navigation in index.md, README.md, docs/README.md
- Remove obsolete planning artifacts (plan.md, investigation.md, comparison.md, composability.md, refactor-main-checklist.md)
2026-02-11 09:33:47 -08:00

36 lines
1.0 KiB
Markdown

---
layout: home
title: SubMiner
tagline: All-in-one sentence mining overlay for MPV with AnkiConnect and dictionary integration
hero:
name: SubMiner
text: Documentation
tagline: Install, configure, and use SubMiner for subtitle-driven mining workflows.
image:
src: /assets/SubMiner.png
alt: SubMiner logo
actions:
- theme: brand
text: Installation
link: /installation
- theme: alt
text: Mining Workflow
link: /mining-workflow
- theme: alt
text: Configuration
link: /configuration
- theme: alt
text: Troubleshooting
link: /troubleshooting
features:
- title: End-to-end workflow
details: Connect mpv subtitle capture, Yomitan lookup, and Anki card generation in one overlay.
- title: Practical configuration
details: Use the complete option reference to tune behavior for mining, media generation, and keybindings.
- title: Contributor docs
details: Build, test, and package SubMiner with the development notes in this docs set.
---