fish-speech/mkdocs.yml at main · fishaudio/fish-speech · 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
site_name: Fish Audio
site_description: Targeting SOTA TTS solutions.
site_url: https://speech.fish.audio

# Repository
repo_name: fishaudio/fish-speech
repo_url: https://github.com/fishaudio/fish-speech
edit_uri: blob/main/docs

# Copyright
copyright: Copyright &copy; 2023-2025 by Fish Audio

theme:
  name: material
  favicon: assets/logo.svg
  language: en
  features:
    - content.action.edit
    - content.action.view
    - navigation.tracking
    - navigation.footer
    # - navigation.tabs
    - search
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
  logo: assets/logo.svg

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: black
      font:
        code: Roboto Mono

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: black
      font:
        code: Roboto Mono

nav:
  - Introduction: en/index.md
  - Installation: en/install.md
  - Finetune: en/finetune.md
  - Inference: en/inference.md
  - Server: en/server.md
  - Samples: en/samples.md

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
      lang:
        - en
        - zh
        - ja
        - pt
        - ko
        - ar
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 简体中文
          build: true
          nav:
            - 介绍: zh/index.md
            - 安装: zh/install.md
            - 微调: zh/finetune.md
            - 推理: zh/inference.md
            - 示例: zh/samples.md
        - locale: ja
          name: 日本語
          build: true
          nav:
            - はじめに: ja/index.md
            - インストール: ja/install.md
            - ファインチューニング: ja/finetune.md
            - 推論: ja/inference.md
            - サンプル: ja/samples.md
        - locale: pt
          name: Português (Brasil)
          build: true
          nav:
            - Introdução: pt/index.md
            - Instalação: pt/install.md
            - Ajuste Fino: pt/finetune.md
            - Inferência: pt/inference.md
            - Amostras: pt/samples.md
        - locale: ko
          name: 한국어
          build: true
          nav:
            - 소개: ko/index.md
            - 설치: ko/install.md
            - 파인튜닝: ko/finetune.md
            - 추론: ko/inference.md
            - 샘플: ko/samples.md
        - locale: ar
          name: العربية
          build: true
          nav:
            - مقدمة: ar/index.md
            - التثبيت: ar/install.md
            - الضبط الدقيق: ar/finetune.md
            - الاستنتاج: ar/inference.md
            - العينات: ar/samples.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.superfences

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Es5qTB9BcN
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/fishaudio/fish-speech
    - icon: fontawesome/brands/qq
      link: http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=jCKlUP7QgSm9kh95UlBoYv6s1I-Apl1M&authKey=xI5ttVAp3do68IpEYEalwXSYZFdfxZSkah%2BctF5FIMyN2NqAa003vFtLqJyAVRfF&noverify=0&group_code=593946093
  homepage: https://speech.fish.audio