增加基于docsify的文档

game14-cn · Aug 16, 2023 · 018c249 · 018c249
1 parent 0525edc
commit 018c249
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -1415,6 +1415,9 @@ cmd输入命令即可：`doctoc /path/to/file`
 ### 2023-08-15
 - 弹幕、入场、礼物的数据库日志记录GUI适配
 
+### 2023-08-16
+- 增加基于docsify的文档
+
 </details>
 
 

diff --git a/_coverpage.md b/_coverpage.md
@@ -0,0 +1,19 @@
+![logo](ui/favicon-256.ico)
+
+# AI Vtuber文档
+
+> AI Vtuber是一个由 ChatterBot/GPT/Claude/langchain本地or云端/chatglm/text-generation-webui/讯飞星火  
+> 做为"大脑"驱动的虚拟主播（Live2D/Vtube Studio）  
+> 可以在 Bilibili/抖音/快手/斗鱼 直播中与观众实时互动 或者 直接在本地和您进行聊天。  
+> 它使用自然语言处理和文本转语音技术(Edge-TTS/VITS/VITS-Fast/elevenlabs/bark-gui)  
+> 生成对观众问题的回答并可以通过so-vits-svc/DDSP-SVC变声；  
+> 另外还可以通过特定指令协同Stable Diffusion进行画图展示。并且可以自定义文案进行循环播放。
+
+- 万 事 皆 有 可 能
+- Everything is possible
+- すべてのことが可能です
+
+[GitHub](https://github.com/Ikaros-521/AI-Vtuber)
+[Gitee](https://gitee.com/ikaros-521/AI-Vtuber)
+[视频教程](https://space.bilibili.com/3709626/channel/collectiondetail?sid=1422512)
+[阅读文档](#AI-Vtuber)
diff --git a/index.html b/index.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>AI Vtuber文档</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'AI Vtuber',
+      repo: 'https://github.com/Ikaros-521/AI-Vtuber',
+      subMaxLevel: 2,
+      //loadNavbar: true,
+      coverpage: true,
+      search: 'auto', // 默认值
+	  // 完整配置参数
+	  search: {
+		maxAge: 86400000,//过期时间,单位毫秒,默认一天
+		paths: [], // or 'auto'
+		placeholder: '请输入搜索关键字',
+		noData: '没有搜到呦!',
+		depth:2
+	  }
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+</body>
+</html>
diff --git a/ui/favicon-256.ico b/ui/favicon-256.ico
diff --git a/ui/favicon-64.ico b/ui/favicon-64.ico