WhisperJAVGE/mkdocs.yml at main · GarntManeetapho/WhisperJAVGE · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# =============================================================================
# WhisperJAV Documentation — MkDocs Material Configuration
# =============================================================================
# Builds to: https://meizhong986.github.io/WhisperJAV/
# Local preview: mkdocs serve
# Deploy: automatic via GitHub Actions on push to main
#
# i18n: mkdocs-static-i18n (folder structure)
#   English: docs/en/   Chinese: docs/zh/
#   Nav paths are language-agnostic — plugin resolves to en/ or zh/ automatically.
# =============================================================================

site_name: WhisperJAV Documentation
site_url: https://meizhong986.github.io/WhisperJAV/
site_description: Japanese Adult Video Subtitle Generator with AI-powered transcription
site_author: MeiZhong
repo_url: https://github.com/meizhong986/whisperjav
repo_name: meizhong986/whisperjav
edit_uri: edit/main/docs/en/

# =============================================================================
# Theme
# =============================================================================
theme:
  name: material
  palette:
    # Dark mode (default)
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Light mode
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.action.edit
    - toc.follow
  icon:
    repo: fontawesome/brands/github

# =============================================================================
# Navigation
# =============================================================================
# User-facing content first, developer docs at the end.
# Paths are language-agnostic — the i18n plugin resolves them to en/ or zh/.
nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Windows (Installer): guides/installation_windows_standalone.md
    - Windows (Python): guides/installation_windows_python.md
    - macOS (Apple Silicon): guides/installation_mac_apple_silicon.md
    - Linux: guides/installation_linux.md
  - User Guide:
    - user-guide/index.md
    - GUI Walkthrough: guides/gui_user_guide.md
    - Common Workflows: user-guide/workflows.md
    - CLI Reference: user-guide/cli-reference.md
    - Output Formats: user-guide/output-formats.md
    - Translation: user-guide/translation.md
  - Pipelines:
    - pipelines/index.md
    - Ensemble Mode: pipelines/ensemble.md
    - ChronosJAV: pipelines/chronosjav.md
    - Qwen3-ASR: pipelines/qwen3-asr.md
  - Upgrading:
    - UPGRADE.md
    - Troubleshooting: UPGRADE_TROUBLESHOOTING.md
    - Manual Rollback: MANUAL_ROLLBACK.md
  - FAQ: faq.md
  - Developer:
    - developer/index.md
    - Architecture Overview: architecture/CONFIG_SOURCES_HIERARCHY.md
    - ADR-001 YAML Config: adr/ADR-001-yaml-config-architecture.md
    - ADR-002 Batched Pipeline: adr/ADR-002-batched-transcription-pipeline.md
    - ADR-003 Qwen3 Integration: architecture/ADR-003-qwen3-asr-integration.md
    - ADR-004 Dedicated Qwen Pipeline: architecture/ADR-004-dedicated-qwen-pipeline.md

# =============================================================================
# Excluded Files
# =============================================================================
# All nav-listed content lives in docs/en/ (and docs/zh/ for Chinese).
# Everything else at docs/ root is internal dev artifacts — exclude from build.
exclude_docs: |
  # Root-level dev artifact files
  SPEECH_SEGMENTER_AUDIT.md
  SCENE_DETECTOR_AUDIT.md
  SCENE_DETECTOR_ARCHITECTURE_REVIEW.md
  SCENE_DETECT_CONTRACT_DESIGN.md
  SCENE_DETECT_MIGRATION_STRATEGY.md
  PIPELINE_AUDIT_FAST_VS_QWEN.md
  CONFIG_ARCHITECTURE.md
  INSTALLATION_STRATEGY.md
  INSTALLATION_GUIDE.md
  VISUALIZATION_USAGE.md
  ISSUE_TRACKER*.md
  ISSUE_ANALYSIS*.md
  CHANGE_REVIEW*.md
  UPGRADE_GUIDE*.md
  RELEASE_PLAN_*.md
  Reference_code_*.py
  release_notes_*.md
  sprint*.md
  # Root-level dev artifact directories (use !en/ to avoid excluding nav content)
  plans/
  plan/
  audit/
  design/
  testing/
  analysis/
  release/
  known_issues/
  drafts/
  external_review/
  research/
  # Root-level architecture/ has non-nav dev artifacts.
  # Nav-listed architecture files live in en/architecture/ (not excluded).
  architecture/A3-*.md
  architecture/ADR-002-multi*.md
  architecture/ADR-005*.md
  architecture/ADR-006*.md
  architecture/COMPOSABILITY*.md
  architecture/COMPUTE_TYPE*.md
  architecture/DEPENDENCY*.md
  architecture/IMPL-*.md
  architecture/INSTALLATION*.md
  architecture/QWEN*.md
  architecture/SCENE*.md
  architecture/UNIFIED*.md
  architecture/V3-IMPL*.md
  architecture/Version2*.md
  architecture/*.txt

# =============================================================================
# Plugins
# =============================================================================
plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 简体中文
          build: true

# =============================================================================
# Markdown Extensions
# =============================================================================
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

# =============================================================================
# Extra
# =============================================================================
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/meizhong986/whisperjav
  alternate:
    - name: English
      link: /WhisperJAV/
      lang: en
    - name: 简体中文
      link: /WhisperJAV/zh/
      lang: zh

copyright: Copyright &copy; 2024-2026 MeiZhong — MIT License