mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
chore: commit remaining docs and project updates
This commit is contained in:
43
docs/index.md
Normal file
43
docs/index.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
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: Configuration
|
||||
link: /configuration
|
||||
- theme: alt
|
||||
text: Development
|
||||
link: /development
|
||||
- theme: alt
|
||||
text: Architecture
|
||||
link: /architecture
|
||||
|
||||
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.
|
||||
---
|
||||
|
||||
## Documentation Sections
|
||||
|
||||
- [Installation](/installation)
|
||||
- [Usage](/usage)
|
||||
- [Configuration](/configuration)
|
||||
- [Development](/development)
|
||||
- [Architecture](/architecture)
|
||||
Reference in New Issue
Block a user