Skip to content

Commit 8139698

Browse files
meizhong986meizhong986
committed
preliminary mkdocs for documentation
1 parent fc4a13a commit 8139698

2 files changed

Lines changed: 193 additions & 0 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# =============================================================================
2+
# Deploy WhisperJAV Documentation to GitHub Pages
3+
# =============================================================================
4+
# Triggers on push to main when docs/ or mkdocs.yml change.
5+
# Uses MkDocs Material to build and deploy to GitHub Pages.
6+
#
7+
# Setup required (one-time):
8+
# 1. Go to repo Settings → Pages → Source → "GitHub Actions"
9+
# 2. That's it. First push to main will create the gh-pages branch.
10+
# =============================================================================
11+
12+
name: Deploy Documentation
13+
14+
on:
15+
push:
16+
branches:
17+
- main
18+
paths:
19+
- 'docs/**'
20+
- 'mkdocs.yml'
21+
workflow_dispatch: # Allow manual trigger
22+
23+
permissions:
24+
contents: write
25+
26+
jobs:
27+
deploy:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@v4
31+
32+
- uses: actions/setup-python@v5
33+
with:
34+
python-version: '3.12'
35+
36+
- name: Install MkDocs Material
37+
run: pip install mkdocs-material
38+
39+
- name: Build and Deploy
40+
run: mkdocs gh-deploy --force

‎mkdocs.yml‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# =============================================================================
2+
# WhisperJAV Documentation — MkDocs Material Configuration
3+
# =============================================================================
4+
# Builds to: https://meizhong986.github.io/whisperjav/
5+
# Local preview: mkdocs serve
6+
# Deploy: automatic via GitHub Actions on push to main
7+
# =============================================================================
8+
9+
site_name: WhisperJAV Documentation
10+
site_url: https://meizhong986.github.io/whisperjav/
11+
site_description: Japanese Adult Video Subtitle Generator with AI-powered transcription
12+
site_author: MeiZhong
13+
repo_url: https://github.com/meizhong986/whisperjav
14+
repo_name: meizhong986/whisperjav
15+
edit_uri: edit/main/docs/
16+
17+
# =============================================================================
18+
# Theme
19+
# =============================================================================
20+
theme:
21+
name: material
22+
palette:
23+
# Dark mode (default)
24+
- scheme: slate
25+
primary: deep purple
26+
accent: amber
27+
toggle:
28+
icon: material/brightness-4
29+
name: Switch to light mode
30+
# Light mode
31+
- scheme: default
32+
primary: deep purple
33+
accent: amber
34+
toggle:
35+
icon: material/brightness-7
36+
name: Switch to dark mode
37+
font:
38+
text: Inter
39+
code: JetBrains Mono
40+
features:
41+
- navigation.sections
42+
- navigation.expand
43+
- navigation.top
44+
- navigation.indexes
45+
- navigation.footer
46+
- search.highlight
47+
- search.suggest
48+
- content.code.copy
49+
- content.action.edit
50+
- toc.follow
51+
icon:
52+
repo: fontawesome/brands/github
53+
54+
# =============================================================================
55+
# Navigation
56+
# =============================================================================
57+
# User-facing content first, developer docs at the end.
58+
# Files not listed here are still accessible by URL but won't appear in nav.
59+
nav:
60+
- Home: index.md
61+
- Getting Started:
62+
- getting-started/index.md
63+
- Windows (Installer): guides/installation_windows_standalone.md
64+
- Windows (Python): guides/installation_windows_python.md
65+
- macOS (Apple Silicon): guides/installation_mac_apple_silicon.md
66+
- Linux: guides/installation_linux.md
67+
- User Guide:
68+
- user-guide/index.md
69+
- GUI Walkthrough: guides/gui_user_guide.md
70+
- Common Workflows: user-guide/workflows.md
71+
- CLI Reference: user-guide/cli-reference.md
72+
- Output Formats: user-guide/output-formats.md
73+
- Translation: user-guide/translation.md
74+
- Pipelines:
75+
- pipelines/index.md
76+
- Ensemble Mode: pipelines/ensemble.md
77+
- ChronosJAV: pipelines/chronosjav.md
78+
- Qwen3-ASR: pipelines/qwen3-asr.md
79+
- Upgrading:
80+
- UPGRADE.md
81+
- Troubleshooting: UPGRADE_TROUBLESHOOTING.md
82+
- Manual Rollback: MANUAL_ROLLBACK.md
83+
- FAQ: faq.md
84+
- Developer:
85+
- developer/index.md
86+
- Architecture Overview: architecture/CONFIG_SOURCES_HIERARCHY.md
87+
- ADR-001 YAML Config: adr/ADR-001-yaml-config-architecture.md
88+
- ADR-002 Batched Pipeline: adr/ADR-002-batched-transcription-pipeline.md
89+
- ADR-003 Qwen3 Integration: architecture/ADR-003-qwen3-asr-integration.md
90+
- ADR-004 Dedicated Qwen Pipeline: architecture/ADR-004-dedicated-qwen-pipeline.md
91+
92+
# =============================================================================
93+
# Excluded Files
94+
# =============================================================================
95+
# Exclude files that aren't valid UTF-8 or are internal dev artifacts.
96+
# MkDocs scans all .md files in docs/ even if not in nav — these would cause
97+
# build errors.
98+
exclude_docs: |
99+
SPEECH_SEGMENTER_AUDIT.md
100+
SCENE_DETECTOR_AUDIT.md
101+
SCENE_DETECTOR_ARCHITECTURE_REVIEW.md
102+
SCENE_DETECT_CONTRACT_DESIGN.md
103+
SCENE_DETECT_MIGRATION_STRATEGY.md
104+
PIPELINE_AUDIT_FAST_VS_QWEN.md
105+
CONFIG_ARCHITECTURE.md
106+
INSTALLATION_STRATEGY.md
107+
INSTALLATION_GUIDE.md
108+
RELEASE_PLAN_*.md
109+
sprint*.md
110+
plans/
111+
plan/
112+
audit/
113+
design/
114+
testing/
115+
analysis/
116+
release/
117+
known_issues/
118+
119+
# =============================================================================
120+
# Plugins
121+
# =============================================================================
122+
plugins:
123+
- search
124+
125+
# =============================================================================
126+
# Markdown Extensions
127+
# =============================================================================
128+
markdown_extensions:
129+
- admonition
130+
- pymdownx.details
131+
- pymdownx.superfences
132+
- pymdownx.tabbed:
133+
alternate_style: true
134+
- pymdownx.highlight:
135+
anchor_linenums: true
136+
- pymdownx.inlinehilite
137+
- pymdownx.keys
138+
- pymdownx.mark
139+
- attr_list
140+
- md_in_html
141+
- tables
142+
- toc:
143+
permalink: true
144+
145+
# =============================================================================
146+
# Extra
147+
# =============================================================================
148+
extra:
149+
social:
150+
- icon: fontawesome/brands/github
151+
link: https://github.com/meizhong986/whisperjav
152+
153+
copyright: Copyright © 2024-2026 MeiZhong — MIT License

0 commit comments

Comments
 (0)