Merge pull request #124 from Ai00-X/docs

UI & docs
Ai00-X · May 24, 2024 · 807d754 · 807d754
2 parents e8aff0a + 9e72003
commit 807d754
Show file tree

Hide file tree

Showing 10 changed files with 1,603 additions and 18 deletions.
diff --git a/assets/www/index.zip b/assets/www/index.zip
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -14,25 +14,23 @@ export default defineConfig({
 
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
-
+    search: {
+      provider: 'local'
+    },
    socialLinks: [
       { icon: 'github', link: 'https://github.com/Ai00-X/ai00_server' }
     ],
 
-
-
-
-
-
   },
   locales: {
     root: {
       label: '简体中文',
       lang: 'zh-CN', // optional, will be added  as `lang` attribute on `html` tag
       themeConfig: {
+        logo: '/logo.gif',
         nav: [
-          { text: '首页', link: '/' },
-          { text: '快速上手', link: '/Simple-Usage' }
+          { text: '指南', link: '/' },
+          { text: '快速上手', link: '/guide/quick-start' }
         ],
         lastUpdated: {
           text: '最后更新于',
@@ -47,14 +45,76 @@ export default defineConfig({
         },
         sidebar: [
           {
-            text: 'Ai00 文档',
+            text: '简介',
+            collapsed: false,
+            base: '/guide/',
             items: [
-              { text: '了解 Ai00', link: '/Introduction' },
-              { text: '快速上手', link: '/Simple-Usage' },
-              { text: '进阶功能', link: '/Ai00-Features' },
-              { text: '常见问题', link: '/FAQ' }
+              { text: '了解 Ai00', link: '/what-is-ai00' },
+              { text: '快速上手', 
+                collapsed: false,
+                items: [
+
+                      { text: '下载编译包', link: '/release' },
+                      { text: '从源码安装', link: '/source-install' },
+                      { text: '配置文件', link: '/config' },
+
+                ]
+              },
+            ]
+          },
+
+          {
+            text: '模型',
+            collapsed: false,
+            base: '/models/',
+            items: [
+              { text: '模型命名规范', link: '/models-name' },
+              { text: 'RWKV基座模型', link: '/rwkv-base' },
+              { text: 'LoRA模型', link: '/lora-model' },
+              { text: 'State模型', link: '/State-model' },
             ]
           } 
+          ,
+          {
+            text: 'WebUI',
+            collapsed: false,
+            base: '/webui/',
+            items: [
+              { text: 'WebUI配置', link: '/webui-config' },
+              { text: 'chat例子', link: '/example-chat' },
+              { text: 'write例子', link: '/example-write' },
+              { text: '多线程例子', link: '/example-multithread' },
+            ]
+          } 
+          ,
+          {
+            text: 'API',
+            collapsed: false,
+            base: '/api/',
+            items: [
+              { text: 'API接口列表', link: '/openai' },
+              { text: '调试API', link: '/debug-api' },
+              { 
+                text: 'SDK调用',
+                base: 'sdk/',
+                collapsed: false,
+                items: [
+                  { text: 'Python SDK', link: '/python-sdk' },
+                  { text: 'JS SDK', link: '/js-sdk' },
+                  { text: 'Rust SDK', link: '/rust-sdk' },
+                ]
+              },
+            ]
+          },
+          {
+            text: '其他',
+            collapsed: false,
+            base: '/guide/',
+            items: [
+              { text: '进阶功能', link: '/features' },
+              { text: '常见问题', link: '/FAQ' }
+            ]
+          },
         ],
 
       },

diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css
@@ -137,3 +137,29 @@
   --docsearch-primary-color: var(--vp-c-brand-1) !important;
 }
 
+/* slim scroll bar for windows based web browsers - works on firefox */
+* {
+  scrollbar-color: var(--vp-c-gutter) var(--vp-button-alt-bg);
+  scrollbar-width: thin;
+}
+
+/* slim scroll bar for windows based web browsers - works on chrome, edge, and safari */
+::-webkit-scrollbar {
+  width: 8px;
+  height: 8px;
+}
+
+/* scrolling handle */
+::-webkit-scrollbar-thumb {
+  background: var(--vp-c-gutter);
+}
+
+/* handle on hover */
+::-webkit-scrollbar-thumb:hover {
+  background: var(--vp-button-alt-hover-bg);
+}
+
+/* scrolling track/backgronund color */
+::-webkit-scrollbar-track {
+  background: var(--vp-button-alt-bg);
+}
diff --git a/docs/FAQ.md → docs/guide/FAQ.md b/docs/FAQ.md → docs/guide/FAQ.md
diff --git a/docs/Ai00-Features.md → docs/guide/features.md b/docs/Ai00-Features.md → docs/guide/features.md
diff --git a/docs/Simple-Usage.md → docs/guide/quick-start.md b/docs/Simple-Usage.md → docs/guide/quick-start.md
diff --git a/docs/Introduction.md → docs/guide/what-is-ai00.md b/docs/Introduction.md → docs/guide/what-is-ai00.md
diff --git a/docs/index.md b/docs/index.md
@@ -5,11 +5,14 @@ layout: home
 hero:
   name: "Ai00 server"
   text: "Just for RWKV"
-  tagline: 支持 Vulkan/Dx12/openGL 的并发推理服务器
+  tagline: 一个本地化、高性能、低消耗的推理服务器
   actions:
     - theme: brand
       text: 快速上手！
-      link: /Simple-Usage
+      link: /guide/quick-start
+    - theme: alt
+      text: 什么是AI00_server？
+      link: /guide/what-is-ai00      
     - theme: alt
       text: 下载安装  
       link: https://github.com/Ai00-X/ai00_server/releases

diff --git a/package.json b/package.json
@@ -14,6 +14,6 @@
   "license": "MIT",
   "devDependencies": {
     "markdown-it-mathjax3": "^4.3.2",
-    "vitepress": "^1.0.0-rc.45"
+    "vitepress": "^1.2.2"
   }
 }