Skip to content

SOTA Open Source TTS

Fix docs

Lengyuee4974141a082
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..4495fe0
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,30 @@
+name: docs
+on:
+ push:
+ branches:
+ - main
+
+permissions:
+ contents: write
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Configure Git Credentials
+ run: |
+ git config user.name github-actions[bot]
+ git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+ - run: pip install mkdocs-material
+ - run: mkdocs gh-deploy --force
diff --git a/README.md b/README.md
index 004f650..014521c 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,8 @@ We do not hold any responsibility for any illegal usage of the codebase. Please
我们不对代码库的任何非法使用承担任何责任. 请参阅您当地关于 DMCA (数字千年法案) 和其他相关法律的法律.
## Documents / 文档
-- [English](https://speech.fish.audio/zh/latest/en/)
-- [中文](https://speech.fish.audio/zh/latest/zh/)
+- [English](https://speech.fish.audio/en/)
+- [中文](https://speech.fish.audio/zh/)
## Credits / 鸣谢
diff --git a/docs/CNAME b/docs/CNAME
new file mode 100644
index 0000000..c82f64e
--- /dev/null
+++ b/docs/CNAME
@@ -0,0 +1 @@
+speech.fish.audio
\ No newline at end of file
diff --git a/docs/en/index.md b/docs/en/index.md
index 6377382..f29b94a 100644
--- a/docs/en/index.md
+++ b/docs/en/index.md
@@ -6,7 +6,7 @@
This codebase is released under the `BSD-3-Clause` license, and all models are released under the CC-BY-NC-SA-4.0 license.
<p align="center">
-<img src="../assets/figs/diagram.png" width="75%">
+<img src="/assets/figs/diagram.png" width="75%">
</p>
## Requirements
diff --git a/docs/en/samples.md b/docs/en/samples.md
index df7f914..43b9bdc 100644
--- a/docs/en/samples.md
+++ b/docs/en/samples.md
@@ -20,28 +20,28 @@
<tbody>
<tr>
<td>Nahida (Genshin Impact)</td>
- <td><audio controls preload="auto" src="../../assets/audios/0_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/0_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/0_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/0_output.wav" /></td>
</tr>
<tr>
<td>Zhongli (Genshin Impact)</td>
- <td><audio controls preload="auto" src="../../assets/audios/1_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/1_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/1_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/1_output.wav" /></td>
</tr>
<tr>
<td>Furina (Genshin Impact)</td>
- <td><audio controls preload="auto" src="../../assets/audios/2_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/2_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/2_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/2_output.wav" /></td>
</tr>
<tr>
<td>Random Speaker 1</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/3_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/3_output.wav" /></td>
</tr>
<tr>
<td>Random Speaker 2</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/4_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/4_output.wav" /></td>
</tr>
</tbody>
</table>
@@ -67,13 +67,13 @@
<tbody>
<tr>
<td>Nahida (Genshin Impact)</td>
- <td><audio controls preload="auto" src="../../assets/audios/0_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/5_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/0_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/5_output.wav" /></td>
</tr>
<tr>
<td>Seiki (Honkai: StarRail)</td>
- <td><audio controls preload="auto" src="../../assets/audios/6_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/6_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/6_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/6_output.wav" /></td>
</tr>
</tbody>
</table>
@@ -98,18 +98,18 @@ patterns to driving cars autonomously, AI's applications are vast and diverse.
<tbody>
<tr>
<td>Speaker 200 (LibriTTS)</td>
- <td><audio controls preload="auto" src="../../assets/audios/7_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/7_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/7_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/7_output.wav" /></td>
</tr>
<tr>
<td>Random Speaker 1</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/8_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/8_output.wav" /></td>
</tr>
<tr>
<td>Random Speaker 2</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/9_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/9_output.wav" /></td>
</tr>
</tbody>
</table>
@@ -134,12 +134,12 @@ patterns to driving cars autonomously, AI's applications are vast and diverse.
<tr>
<td>Random Speaker 1</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/10_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/10_output.wav" /></td>
</tr>
<tr>
<td>Random Speaker 2</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/11_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/11_output.wav" /></td>
</tr>
</tbody>
</table>
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
index a88af87..bb0aba9 100644
--- a/docs/stylesheets/extra.css
+++ b/docs/stylesheets/extra.css
@@ -1,3 +1,6 @@
.md-grid {
max-width: 1440px;
}
+.md-tabs {
+ display: none;
+}
\ No newline at end of file
diff --git a/docs/zh/index.md b/docs/zh/index.md
index b7f1fc9..61e757c 100644
--- a/docs/zh/index.md
+++ b/docs/zh/index.md
@@ -6,7 +6,7 @@
此代码库根据 `BSD-3-Clause` 许可证发布, 所有模型根据 CC-BY-NC-SA-4.0 许可证发布.
<p align="center">
-<img src="../assets/figs/diagram.png" width="75%">
+<img src="/assets/figs/diagram.png" width="75%">
</p>
## 要求
diff --git a/docs/zh/samples.md b/docs/zh/samples.md
index f8d529d..27c844a 100644
--- a/docs/zh/samples.md
+++ b/docs/zh/samples.md
@@ -20,28 +20,28 @@
<tbody>
<tr>
<td>纳西妲 (原神)</td>
- <td><audio controls preload="auto" src="../../assets/audios/0_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/0_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/0_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/0_output.wav" /></td>
</tr>
<tr>
<td>钟离 (原神)</td>
- <td><audio controls preload="auto" src="../../assets/audios/1_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/1_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/1_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/1_output.wav" /></td>
</tr>
<tr>
<td>芙宁娜 (原神)</td>
- <td><audio controls preload="auto" src="../../assets/audios/2_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/2_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/2_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/2_output.wav" /></td>
</tr>
<tr>
<td>随机说话人 1</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/3_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/3_output.wav" /></td>
</tr>
<tr>
<td>随机说话人 2</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/4_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/4_output.wav" /></td>
</tr>
</tbody>
</table>
@@ -67,13 +67,13 @@
<tbody>
<tr>
<td>纳西妲 (原神)</td>
- <td><audio controls preload="auto" src="../../assets/audios/0_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/5_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/0_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/5_output.wav" /></td>
</tr>
<tr>
<td>青雀 (星穹铁道)</td>
- <td><audio controls preload="auto" src="../../assets/audios/6_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/6_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/6_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/6_output.wav" /></td>
</tr>
</tbody>
</table>
@@ -98,18 +98,18 @@ patterns to driving cars autonomously, AI's applications are vast and diverse.
<tbody>
<tr>
<td>Speaker 200 (LibriTTS)</td>
- <td><audio controls preload="auto" src="../../assets/audios/7_input.wav" /></td>
- <td><audio controls preload="auto" src="../../assets/audios/7_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/7_input.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/7_output.wav" /></td>
</tr>
<tr>
<td>随机说话人 1</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/8_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/8_output.wav" /></td>
</tr>
<tr>
<td>随机说话人 2</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/9_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/9_output.wav" /></td>
</tr>
</tbody>
</table>
@@ -135,12 +135,12 @@ patterns to driving cars autonomously, AI's applications are vast and diverse.
<tr>
<td>随机说话人 1</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/10_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/10_output.wav" /></td>
</tr>
<tr>
<td>随机说话人 2</td>
<td> - </td>
- <td><audio controls preload="auto" src="../../assets/audios/11_output.wav" /></td>
+ <td><audio controls preload="auto" src="/assets/audios/11_output.wav" /></td>
</tr>
</tbody>
</table>
diff --git a/mkdocs.yml b/mkdocs.yml
index c25dbc6..8d75b8c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -8,6 +8,7 @@ theme:
- navigation.instant
- navigation.instant.prefetch
- navigation.tracking
+ - navigation.tabs
- search
- search.suggest
- search.highlight
@@ -43,8 +44,6 @@ theme:
extra:
homepage: https://speech.fish.audio
- version:
- provider: mike
alternate:
- name: English
link: /en/