📝 更新文档

CONTRIBUTING.md

@@ -19,17 +19,17 @@ SoraBot 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功
 
 ## Pull Request
 
-SoraBot 使用 poetry 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
+SoraBot 使用 PDM 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
 
-下面的命令能在已安装 poetry 和 pnpm 的情况下帮你快速配置开发环境。
+下面的命令能在已安装 PDM 和 pnpm 的情况下帮你快速配置开发环境。
 
 ```bash
 # 安装 pipx 工具
 pip install pipx
-# 安装 poetry 虚拟环境
-pipx install poetry
+# 安装 PDM 虚拟环境
+pipx install pdm
 # 安装 python 依赖
-poetry install
+pdm install
 # 安装 pre-commit git hook
 pre-commit install
 ```
@@ -46,7 +46,7 @@ pre-commit install
 
 请确保你的每一个 commit 都能清晰地描述其意图，一个 commit 尽量只有一个意图。
 
-SoraBot 的 commit message 格式遵循 gitmoji 规范，在创建 commit 时请牢记这一点。
+SoraBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。
 
 ### 工作流概述
 
@@ -79,38 +79,6 @@ SoraBot 文档并没有具体的行文风格规范，但我们建议你尽量写
 
 如果你需要编辑器检查 Markdown 规范，可以在 VSCode 中安装 markdownlint 扩展。
 
-### 文件夹规范
-
-实际上，若无开发需求，您暂时不用了解每一个文件的作用
-
-```bash
-📦 SoraBot
-├── 📂 go-cqhttp
-│   └── ......
-├── 📂 SoraBot
-│   └── 📂 sora
-│       └── 📂 configs          // 配置
-│       └── 📂 database         // 数据库
-│       └── 📂 plugins          // 插件
-│       └── 📂 utils            // 工具
-│       └── 📜 ...  
-│   └── 📂 website
-│       └── 📂 .vitepress
-│           └── 📜 config.ts    // 配置文件
-│       └── 📂 develop          // 开发文档
-│       └── 📂 module           // 使用文档
-│       └── 📜 package.json
-│       └── 📜 README.md
-│   └── 📜 .env                 // 配置文件
-│   └── 📜 .env.prod            // 配置文件
-│   └── 📜 bot.py               // 启动文件
-│   └── 📜 matcher_patch.py
-│   └── 📜 poetry.lock          // 依赖管理
-│   └── 📜 pyproject.toml  
-|   └── 📜 README.md  
-|   └── 📜 requirements.txt     // 依赖列表  
-```
-
 ### 参与开发
 
 SoraBot 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 与 [PEP 484](https://www.python.org/dev/peps/pep-0484/) 规范，请确保你的代码风格和项目已有的代码保持一致，变量命名清晰，有适当的注释与测试代码。

docs/.vitepress/components/VPBadge.vue

@@ -0,0 +1,112 @@
+<!-- 修改自 Vitepress -->
+
+<script setup lang="ts">
+defineProps<{
+  text?: string
+  type?: 'new' | 'update' | 'info' | 'tip' | 'warning' | 'danger' | 'private' | 'owner' | 'helper' | 'telegram'
+}>()
+</script>
+
+<template>
+  <span class="VPBadge" :class="type ?? 'tip'">
+    <slot>{{ text }}</slot>
+  </span>
+</template>
+
+<style scoped>
+.VPBadge {
+  display: inline-block;
+  margin-left: 2px;
+  border: 1px solid transparent;
+  border-radius: 12px;
+  padding: 0 10px;
+  line-height: 22px;
+  font-size: 12px;
+  font-weight: 600;
+  transform: translateY(-2px);
+}
+
+.vp-doc h1>.VPBadge {
+  margin-top: 4px;
+  vertical-align: top;
+}
+
+.vp-doc h2>.VPBadge {
+  margin-top: 3px;
+  line-height: 20px;
+  padding: 0 8px;
+  vertical-align: top;
+}
+
+.vp-doc h3>.VPBadge {
+  line-height: 20px;
+  vertical-align: middle;
+}
+
+.vp-doc h4>.VPBadge,
+.vp-doc h5>.VPBadge,
+.vp-doc h6>.VPBadge {
+  vertical-align: middle;
+  line-height: 18px;
+}
+
+.VPBadge.info {
+  border-color: var(--vp-badge-info-border);
+  color: var(--vp-badge-info-text);
+  background-color: var(--vp-badge-info-bg);
+}
+
+.VPBadge.tip {
+  border-color: var(--vp-badge-tip-border);
+  color: var(--vp-badge-tip-text);
+  background-color: var(--vp-badge-tip-bg);
+}
+
+.VPBadge.warning {
+  border-color: var(--vp-badge-warning-border);
+  color: var(--vp-badge-warning-text);
+  background-color: var(--vp-badge-warning-bg);
+}
+
+.VPBadge.danger {
+  border-color: var(--vp-badge-danger-border);
+  color: var(--vp-badge-danger-text);
+  background-color: var(--vp-badge-danger-bg);
+}
+
+.VPBadge.private {
+  border-color: var(--vp-badge-private-border);
+  color: var(--vp-badge-private-text);
+  background-color: var(--vp-badge-private-bg);
+}
+
+.VPBadge.owner {
+  border-color: var(--vp-badge-owner-border);
+  color: var(--vp-badge-owner-text);
+  background-color: var(--vp-badge-owner-bg);
+}
+
+.VPBadge.helper {
+  border-color: var(--vp-badge-helper-border);
+  color: var(--vp-badge-helper-text);
+  background-color: var(--vp-badge-helper-bg);
+}
+
+.VPBadge.telegram {
+  border-color: var(--vp-badge-telegram-border);
+  color: var(--vp-badge-telegram-text);
+  background-color: var(--vp-badge-telegram-bg);
+}
+
+.VPBadge.new {
+  border-color: var(--vp-badge-new-border);
+  color: var(--vp-badge-new-text);
+  background-color: var(--vp-badge-new-bg);
+}
+.VPBadge.update {
+  border-color: var(--vp-badge-update-border);
+  color: var(--vp-badge-update-text);
+  background-color: var(--vp-badge-update-bg);
+}
+
+</style>

docs/.vitepress/config.ts

@@ -14,7 +14,7 @@ export default defineConfig({
   cleanUrls: true,
 
   head: [
-    ['link', { rel: 'shortcut icon', href: '/favicon.png' }],
+    ['link', { rel: 'shortcut icon', href: '/logo.jpg' }],
     ['script', { src: 'https://cdn.bootcdn.net/ajax/libs/mermaid/10.3.0/mermaid.min.js' }]
   ],
 
@@ -31,7 +31,7 @@ export default defineConfig({
       pattern: 'https://github.com/netsora/SoraBot-website/edit/remake/docs/:path',
       text: '在 GitHub 上编辑此页'
     },
-    socialLinks: [{ icon: 'github', link: 'https://github.com/netsora/SoraBot-website' }],
+    socialLinks: [{ icon: 'github', link: 'https://github.com/netsora/SoraBot' }],
     footer: {
       message: 'AGPL-3.0 License',
       copyright: 'Copyright © 2023 Sora Network'

docs/.vitepress/sidebar.ts

@@ -8,7 +8,8 @@ const module = [
   {
     text: '基础',
     items: [
-      { text: '更新', link: '/module/base/manager' },
+      { text: '帮助', link: '/module/base/help' },
+      { text: '管理', link: '/module/base/manager' },
     ]
   },
   {
@@ -38,7 +39,7 @@ const guide = [
   {
     text: '部署',
     items: [
-      { text: '使用 Docker 部署', link: '/guide/deploy/' },
+      { text: '使用 Docker 部署', link: '/guide/deploy/docker' },
     ]
   },
 ]

docs/.vitepress/styles/index.scss

@@ -8,6 +8,30 @@
 }
 
 :root {
+  --vp-badge-new-border: #52c41a;
+  --vp-badge-new-text: #52c41a;
+  --vp-badge-new-bg: #f6ffed;
+
+  --vp-badge-update-border: #c796ff;
+  --vp-badge-update-text: #b97efc;
+  --vp-badge-update-bg: #eaeaff;
+
+  --vp-badge-owner-border: #fd8637;
+  --vp-badge-owner-text: #FF8D40;
+  --vp-badge-owner-bg: #fff0e7;
+
+  --vp-badge-private-border: #0070bb;
+  --vp-badge-private-text: #007EC6;
+  --vp-badge-private-bg: #e0f3ff;
+
+  --vp-badge-helper-border: #f95050;
+  --vp-badge-helper-text: #e75a5a;
+  --vp-badge-helper-bg: #ffcdcd2c;
+
+  --vp-badge-telegram-border: #1fa5ff;
+  --vp-badge-telegram-text: #2a96df;
+  --vp-badge-telegram-bg: #def3ff;
+
   --vp-font-family-base: 'HarmonyOSHans', 'HarmonyOS Sans SC', -apple-system, BlinkMacSystemFont,
     'Segoe UI', Oxygen, Ubuntu, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', Microsoft YaHei,
     sans-serif;
@@ -17,6 +41,15 @@ html {
   scroll-behavior: smooth;
 }
 
+.dark {
+  --vp-badge-new-bg: #aeff9620;
+  --vp-badge-update-bg: #333342;
+  --vp-badge-private-bg: #6cc7ff0d;
+  --vp-badge-owner-bg: #ffa56916;
+  --vp-badge-helper-bg: #ffdede00;
+  --vp-badge-telegram-bg: #ff84990d;
+}
+
 // 滑稽表情
 .face {
   display: inline;

docs/.vitepress/theme/index.ts

@@ -23,6 +23,7 @@ import MoreInfo from '../components/MoreInfo.vue'
 import ProjectInfo from '../components/ProjectInfo.vue'
 import RubyCurtain from '../components/RubyCurtain.vue'
 import VolumeBar from '../components/VolumeBar.vue'
+import VPBadge from '../components/VPBadge.vue'
 
 import '../styles/index.scss'
 
@@ -55,6 +56,7 @@ const theme: Theme = {
     app.component('ProjectInfo', ProjectInfo)
     app.component('RubyCurtain', RubyCurtain)
     app.component('VolumeBar', VolumeBar)
+    app.component('Badge', VPBadge)
 
     app.component('CodeGroup', CodeGroup)
     app.component('CodeGroupItem', CodeGroupItem)

docs/about/contribute.md

@@ -28,17 +28,17 @@ SoraBot 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功
 
 ## Pull Request
 
-SoraBot 使用 poetry 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
+SoraBot 使用 PDM 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
 
-下面的命令能在已安装 poetry 和 pnpm 的情况下帮你快速配置开发环境。
+下面的命令能在已安装 PDM 和 pnpm 的情况下帮你快速配置开发环境。
 
 ```bash
 # 安装 pipx 工具
 pip install pipx
-# 安装 poetry 虚拟环境
-pipx install poetry
+# 安装 PDM 虚拟环境
+pipx install pdm
 # 安装 python 依赖
-poetry install
+pdm install
 # 安装 pre-commit git hook
 pre-commit install
 ```
@@ -55,7 +55,7 @@ pre-commit install
 
 请确保你的每一个 commit 都能清晰地描述其意图，一个 commit 尽量只有一个意图。
 
-SoraBot 的 commit message 格式遵循 gitmoji 规范，在创建 commit 时请牢记这一点。
+SoraBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。
 
 ### 工作流概述
 
@@ -88,38 +88,6 @@ SoraBot 文档并没有具体的行文风格规范，但我们建议你尽量写
 
 如果你需要编辑器检查 Markdown 规范，可以在 VSCode 中安装 markdownlint 扩展。
 
-### 文件夹规范
-
-实际上，若无开发需求，您暂时不用了解每一个文件的作用
-
-```bash
-📦 SoraBot
-├── 📂 go-cqhttp
-│   └── ......
-├── 📂 SoraBot
-│   └── 📂 sora
-│       └── 📂 configs          // 配置
-│       └── 📂 database         // 数据库
-│       └── 📂 plugins          // 插件
-│       └── 📂 utils            // 工具
-│       └── 📜 ...  
-│   └── 📂 website
-│       └── 📂 .vitepress
-│           └── 📜 config.ts    // 配置文件
-│       └── 📂 develop          // 开发文档
-│       └── 📂 module           // 使用文档
-│       └── 📜 package.json
-│       └── 📜 README.md
-│   └── 📜 .env                 // 配置文件
-│   └── 📜 .env.prod            // 配置文件
-│   └── 📜 bot.py               // 启动文件
-│   └── 📜 matcher_patch.py
-│   └── 📜 poetry.lock          // 依赖管理
-│   └── 📜 pyproject.toml  
-|   └── 📜 README.md  
-|   └── 📜 requirements.txt     // 依赖列表  
-```
-
 ### 参与开发
 
 SoraBot 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 与 [PEP 484](https://www.python.org/dev/peps/pep-0484/) 规范，请确保你的代码风格和项目已有的代码保持一致，变量命名清晰，有适当的注释与测试代码。

docs/guide/before/introduction.md

@@ -3,7 +3,7 @@ title: 介绍
 prev: false
 next:
   text: "准备工作 →"
-  link: "develop/forward/prepare"
+  link: "guide/before/prepare"
 ---
 
 # 介绍