mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-28 06:22:45 -08:00
sudacode
4fb1c1722d
- 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)
24 lines
1.1 KiB
Markdown
24 lines
1.1 KiB
Markdown
# Documentation
|
|
|
|
SubMiner documentation is built with [VitePress](https://vitepress.dev/).
|
|
|
|
## Local Docs Site
|
|
|
|
```bash
|
|
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
|
|
|
|
- [Installation](/installation) — Platform requirements, AppImage/macOS/source installs, mpv plugin
|
|
- [Usage](/usage) — Script vs plugin workflow, keybindings, YouTube playback
|
|
- [Mining Workflow](/mining-workflow) — End-to-end sentence mining guide, overlay layers, card creation
|
|
- [Configuration](/configuration) — Full config file reference and option details
|
|
- [Anki Integration](/anki-integration) — AnkiConnect setup, field mapping, media generation, field grouping
|
|
- [MPV Plugin](/mpv-plugin) — Chord keybindings, subminer.conf options, script messages
|
|
- [Troubleshooting](/troubleshooting) — Common issues and solutions by category
|
|
- [Development](/development) — Building, testing, contributing, environment variables
|
|
- [Architecture](/architecture) — Service-oriented design, composition model, extension rules
|