mlx-vc/mkdocs.yml at main · feiyuehchen/mlx-vc · 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
# MkDocs configuration. Builds a static site under ./site/.
# Local preview:  mkdocs serve
# GitHub Pages :  mkdocs gh-deploy
site_name: mlx-vc
site_description: Voice conversion on Apple Silicon using MLX
site_url: https://feiyuehchen.github.io/mlx-vc/
repo_url: https://github.com/feiyuehchen/mlx-vc
repo_name: feiyuehchen/mlx-vc

theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tabs
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# Bilingual: English (default) + Traditional Chinese.
# Pages live under docs/en/ and docs/zh/ with parallel structure.
plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 繁體中文
          build: true
          nav_translations:
            Home: 首頁
            Getting Started: 開始使用
            Installation: 安裝
            Quick Start: 快速入門
            Models: 模型
            Overview: 總覽
            Full Comparison: 完整比較表
            Guides: 教學
            Real-time Demo: 即時轉換 Demo
            Discord Integration: Discord 整合
            Server API: Server API
            Evaluation Metrics: 評估指標
            Contributing: 貢獻
            Development Setup: 開發環境
            Adding a Model: 新增模型

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Models:
      - Overview: models/index.md
      - Full Comparison: models.md
      - Seed-VC: models/seed-vc.md
      - OpenVoice V2: models/openvoice.md
      - kNN-VC: models/knn-vc.md
      - CosyVoice3: models/cosyvoice.md
      - RVC: models/rvc.md
      - MeanVC: models/meanvc.md
  - Guides:
      - Real-time Demo: guides/realtime.md
      - Discord Integration: guides/discord.md
      - Server API: guides/server.md
      - Evaluation Metrics: guides/evaluation.md
  - Contributing:
      - Development Setup: contributing/dev-setup.md
      - Adding a Model: contributing/adding-a-model.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - tables
  - attr_list
  - md_in_html
  - footnotes
  - toc:
      permalink: true