mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-28 06:22:45 -08:00
Apply remaining working-tree updates
This commit is contained in:
144
docs/index.md
144
docs/index.md
@@ -2,18 +2,18 @@
|
||||
layout: home
|
||||
|
||||
title: SubMiner
|
||||
tagline: All-in-one sentence mining overlay for MPV with AnkiConnect and dictionary integration
|
||||
titleTemplate: Sentence Mining Overlay for MPV
|
||||
|
||||
hero:
|
||||
name: SubMiner
|
||||
text: Documentation
|
||||
tagline: Install, configure, and use SubMiner for subtitle-driven mining workflows.
|
||||
text: Sentence Mining for MPV
|
||||
tagline: Click on subtitles. Look up words. Mine to Anki. All without leaving the video.
|
||||
image:
|
||||
src: /assets/SubMiner.png
|
||||
alt: SubMiner logo
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Installation
|
||||
text: Get Started
|
||||
link: /installation
|
||||
- theme: alt
|
||||
text: Mining Workflow
|
||||
@@ -21,15 +21,133 @@ hero:
|
||||
- theme: alt
|
||||
text: Configuration
|
||||
link: /configuration
|
||||
- theme: alt
|
||||
text: Troubleshooting
|
||||
link: /troubleshooting
|
||||
|
||||
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.
|
||||
- icon: "🎯"
|
||||
title: Click-to-Lookup Overlay
|
||||
details: Subtitles are tokenized into clickable words. Click any word to open a Yomitan dictionary popup — right on top of the video.
|
||||
- icon: "📇"
|
||||
title: Automatic Anki Cards
|
||||
details: Add a word from Yomitan and SubMiner fills in the sentence, audio clip, screenshot, and translation automatically.
|
||||
- icon: "🪟"
|
||||
title: Dual-Layer Subtitle System
|
||||
details: Visible overlay with styled, interactive subtitles — plus an invisible layer that aligns with mpv's own subtitle rendering for seamless click-through lookup.
|
||||
- icon: "🎬"
|
||||
title: YouTube & Subtitle Sync
|
||||
details: Play YouTube videos with auto-generated subtitles. Sync external subtitle files with alass or ffsubsync. Search and download anime subtitles from Jimaku.
|
||||
- icon: "🔠"
|
||||
title: Smart Tokenization
|
||||
details: Japanese text is segmented using Yomitan's internal parser with MeCab fallback, enabling accurate word boundary detection for dictionary lookups.
|
||||
- icon: "⌨️"
|
||||
title: Keyboard-Driven Workflow
|
||||
details: Mine sentences, copy subtitles, cycle display modes, and trigger field grouping — all from configurable keyboard shortcuts without touching the mouse.
|
||||
---
|
||||
|
||||
<style>
|
||||
.demo-section {
|
||||
max-width: 960px;
|
||||
margin: 2rem auto 0;
|
||||
padding: 0 24px;
|
||||
}
|
||||
|
||||
.demo-section h2 {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 600;
|
||||
margin-bottom: 0.75rem;
|
||||
}
|
||||
|
||||
.demo-section p {
|
||||
color: var(--vp-c-text-2);
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.demo-section video {
|
||||
width: 100%;
|
||||
border-radius: 8px;
|
||||
border: 1px solid var(--vp-c-divider);
|
||||
}
|
||||
|
||||
.workflow-section {
|
||||
max-width: 960px;
|
||||
margin: 3rem auto 0;
|
||||
padding: 0 24px 3rem;
|
||||
}
|
||||
|
||||
.workflow-section h2 {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 600;
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
|
||||
.workflow-steps {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
||||
gap: 1rem;
|
||||
}
|
||||
|
||||
.workflow-step {
|
||||
padding: 1rem;
|
||||
border-radius: 8px;
|
||||
border: 1px solid var(--vp-c-divider);
|
||||
background: var(--vp-c-bg-soft);
|
||||
}
|
||||
|
||||
.workflow-step .step-number {
|
||||
font-size: 0.8rem;
|
||||
font-weight: 700;
|
||||
color: var(--vp-c-brand-1);
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.workflow-step .step-title {
|
||||
font-weight: 600;
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.workflow-step .step-desc {
|
||||
font-size: 0.875rem;
|
||||
color: var(--vp-c-text-2);
|
||||
}
|
||||
</style>
|
||||
|
||||
<div class="demo-section">
|
||||
|
||||
## See It in Action
|
||||
|
||||
SubMiner sits as a transparent overlay on top of mpv. Subtitles appear as interactive, clickable text — click a word to look it up with Yomitan, then add it to Anki with one click.
|
||||
|
||||
<video controls playsinline preload="metadata" poster="/assets/demo-poster.jpg">
|
||||
<source :src="'/assets/card-mine.webm'" type="video/webm" />
|
||||
Your browser does not support the video tag.
|
||||
</video>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="workflow-section">
|
||||
|
||||
## How It Works
|
||||
|
||||
<div class="workflow-steps">
|
||||
<div class="workflow-step">
|
||||
<div class="step-number">01</div>
|
||||
<div class="step-title">Watch</div>
|
||||
<div class="step-desc">Play a video in mpv. SubMiner connects via IPC and captures subtitles in real time.</div>
|
||||
</div>
|
||||
<div class="workflow-step">
|
||||
<div class="step-number">02</div>
|
||||
<div class="step-title">Look Up</div>
|
||||
<div class="step-desc">Click any word in the subtitle overlay. Yomitan opens its dictionary popup instantly.</div>
|
||||
</div>
|
||||
<div class="workflow-step">
|
||||
<div class="step-number">03</div>
|
||||
<div class="step-title">Mine</div>
|
||||
<div class="step-desc">Add the word to Anki from Yomitan. SubMiner detects the new card automatically.</div>
|
||||
</div>
|
||||
<div class="workflow-step">
|
||||
<div class="step-number">04</div>
|
||||
<div class="step-title">Enrich</div>
|
||||
<div class="step-desc">SubMiner fills in the sentence, audio clip, screenshot, and translation — no extra steps.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user