SubMiner/docs/index.md at f345547963116f326d9d288bfc4823114b772b19

mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-02-28 06:22:45 -08:00

Files

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

1.0 KiB

Raw Blame History

layout, title, tagline, hero, features

layout

title

tagline

hero

features

home

SubMiner

All-in-one sentence mining overlay for MPV with AnkiConnect and dictionary integration

name

text

tagline

image

actions

SubMiner

Documentation

Install, configure, and use SubMiner for subtitle-driven mining workflows.

src	alt
/assets/SubMiner.png	SubMiner logo

theme	text	link
brand	Installation	/installation

theme	text	link
alt	Mining Workflow	/mining-workflow

theme	text	link
alt	Configuration	/configuration

theme	text	link
alt	Troubleshooting	/troubleshooting

title	details
End-to-end workflow	Connect mpv subtitle capture, Yomitan lookup, and Anki card generation in one overlay.

title	details
Practical configuration	Use the complete option reference to tune behavior for mining, media generation, and keybindings.

title	details
Contributor docs	Build, test, and package SubMiner with the development notes in this docs set.

1.0 KiB Raw Blame History

1.0 KiB

Raw Blame History