mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
38 lines
821 B
Markdown
38 lines
821 B
Markdown
# Documentation
|
|
|
|
Use this directory for detailed SubMiner documentation.
|
|
|
|
## Local Docs Site
|
|
|
|
Run the VitePress docs site locally:
|
|
|
|
```bash
|
|
pnpm run docs:dev
|
|
```
|
|
|
|
Build static docs output:
|
|
|
|
```bash
|
|
pnpm run docs:build
|
|
```
|
|
|
|
- [Installation](/installation)
|
|
- Platform requirements
|
|
- AppImage / macOS / source installs
|
|
- mpv plugin setup
|
|
- [Usage](/usage)
|
|
- Script vs plugin workflow
|
|
- Running SubMiner with mpv
|
|
- Keybindings and runtime behavior
|
|
- [Configuration](/configuration)
|
|
- Full config file reference and option details
|
|
- [Development](/development)
|
|
- Contributor notes
|
|
- Architecture and extension rules
|
|
- Environment variables
|
|
- License and acknowledgments
|
|
- [Architecture](/architecture)
|
|
- Service-oriented runtime structure
|
|
- Composition and lifecycle model
|
|
- Extension design rules
|