mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-28 06:22:45 -08:00
chore: commit remaining docs and project updates
This commit is contained in:
@@ -2,17 +2,36 @@
|
||||
|
||||
Use this directory for detailed SubMiner documentation.
|
||||
|
||||
- [Installation](installation.md)
|
||||
## 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.md)
|
||||
- [Usage](/usage)
|
||||
- Script vs plugin workflow
|
||||
- Running SubMiner with mpv
|
||||
- Keybindings and runtime behavior
|
||||
- [Configuration](configuration.md)
|
||||
- [Configuration](/configuration)
|
||||
- Full config file reference and option details
|
||||
- [Development](development.md)
|
||||
- [Development](/development)
|
||||
- Contributor notes
|
||||
- Architecture migration overview
|
||||
- Environment variables
|
||||
- License and acknowledgments
|
||||
- [Architecture](/architecture)
|
||||
- Composability migration status
|
||||
- Core runtime structure
|
||||
- Extension design rules
|
||||
|
||||
Reference in New Issue
Block a user