更新文档，添加版本时间线

ikenxuan · Jun 29, 2024 · 803b9cd · 803b9cd
1 parent 140ff6d
commit 803b9cd
Show file tree

Hide file tree

Showing 11 changed files with 97 additions and 701 deletions.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -1,5 +1,6 @@
 import { defineConfig } from 'vitepress'
 import timeline from 'vitepress-markdown-timeline'
+import taskLists from "markdown-it-task-lists"
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -17,6 +18,7 @@ export default defineConfig({
     config: (md) => {
       //时间线
       md.use(timeline)
+      md.use(taskLists)
     },
   },
   cleanUrls: true,
@@ -63,6 +65,7 @@ export default defineConfig({
           {
             text: '其他',
             items: [
+              { text: '版本时间线', link: '/docs/other/timeline' },
               { text: '免责声明', link: '/docs/other/disclaimer' },
               { text: '投喂', link: '/docs/other/afdian' },
             ],
@@ -95,6 +98,7 @@ export default defineConfig({
       {
         text: '其他',
         items: [
+          { text: '版本时间线', link: '/docs/other/timeline' },
           { text: '免责声明', link: '/docs/other/disclaimer' },
           { text: '投喂', link: '/docs/other/afdian' },
         ],
@@ -118,7 +122,7 @@ export default defineConfig({
     lastUpdatedText: '最后编辑于',
     outlineTitle: '本页目录',
     footer: {
-      message: 'Released under the GPL-3.0 License',
+      message: "Released under the <a href='https://github.com/ikenxuan/kkkkkk-10086/blob/master/LICENSE'>GPL-3.0 License</a>",
       copyright: "Copyright © 2023-2024 <a href='https://github.com/ikenxuan'>ikenxuan</a>",
     },
     docFooter: {

diff --git a/docs/intro/QA.md b/docs/intro/QA.md
@@ -1,13 +1,27 @@
 # 常见问题
 
 ::: details 报错：**<span style="color:#D7474B">TypeError: response.body.on is not a function</span>**
-
 ```sh
 # 方法1：到插件目录下重新安装依赖（推荐）
 cd plugins/kkkkkk-10086/ && pnpm install -P
 
 # 方法2：node.js 版本 >= v21
 nvm use 21.0.0
 ```
+:::
+
+
+
+::: details 报错：**<span style="color:#D7474B">视频合成失败 Error: Command failed: ffmpeg -y -i ......</span>**
+可能是你没有配置 [**FFmpeg**](https://ffmpeg.org/) 的环境变量<br>
+
+* **Ubuntu 系统解决方法**<br>
+安装完成后在终端输入 `ffmpeg –version` 弹出版本信息 `ffmpeg version 202...` 即安装成功
+```sh
+# 你可以通过以下命令来安装 FFmpeg 并配置环境变量
+sudo apt install ffmpeg
+```
 
+* **Windows 系统解决方法**<br>
+参考 CSDN 文章 [ffmpeg安装教程（windows版）](https://blog.csdn.net/m0_47449768/article/details/130102406)
 :::
diff --git a/docs/intro/bilibili.md b/docs/intro/bilibili.md
@@ -29,8 +29,8 @@
 
 ### 配置 Cookie
 
-获取到 Cookie 后 使用 `#kkk设置B站ck` 后发送 Cookie 即可配置成功<br>
-或者使用 [**Guoba-Plugin**](https://github.com/guoba-yunzai/guoba-plugin) 进行配置<br>
+获取到 Cookie 后 使用 `#kkk设置B站ck` 后发送 Cookie 即可配置成功<br><br>
+或者使用 [**后台面板**](../start/start.config.md) 进行配置<br><br>
 手动配置则需要打开配置文件 `config/config/cookies.yaml` ，根据提示将对应的值替换成你获取到的 Cookie
 
 ```yaml{5}

diff --git a/docs/intro/douyin.md b/docs/intro/douyin.md
@@ -29,8 +29,8 @@
 
 ### 配置 Cookie
 
-获取到 Cookie 后 使用 `#kkk设置抖音ck` 后发送 Cookie 即可配置成功<br>
-或者使用 [**Guoba-Plugin**](https://github.com/guoba-yunzai/guoba-plugin) 进行配置<br>
+获取到 Cookie 后 使用 `#kkk设置抖音ck` 后发送 Cookie 即可配置成功<br><br>
+或者使用 [**后台面板**](../start/start.config.md) 进行配置<br><br>
 手动配置则需要打开配置文件 `config/config/cookies.yaml` ，根据提示将对应的值替换成你获取到的 Cookie
 
 ```yaml{2}

diff --git a/docs/intro/push.md b/docs/intro/push.md
@@ -23,4 +23,4 @@
 
 ## TODO
 
-已完成！~~往后可能会根据配置文件内容进行内容渲染，而不是通过数据库缓存~~
+- [x] 往后可能会根据配置文件内容进行内容渲染，而不是通过数据库缓存<br>由 [**@ikenxuan**](https://github.com/ikenxuan) 在 [**95dcffa**](https://github.com/ikenxuan/kkkkkk-10086/commit/95dcffab00f8afc1484a1e350911636b2d92006d) 完成
diff --git a/docs/other/disclaimer.md b/docs/other/disclaimer.md
@@ -4,6 +4,4 @@
 
 本项目提供的开源代码是出于学习进行开发。如果您认为该项目侵犯了您的知识产权或其他合法权益，请通过 **[QQ](https://qm.qq.com/q/k6Up32hdWE)** 向我们提供书面通知。我们将在收到有效通知后，尽快进行审查，并采取必要的措施。
 
-本软件出于学习进行开发，使用本项目的使用本软件的用户应确保遵守所有适用的开源许可证协议，并且在使用过程中尊重原作者的知识产权。
-
-<p style="color: red; font-weight: bolder;">未经同意，禁止将本项目的开源代码用于任何商业目的。因使用本项目产生的一切问题与后果由使用者自行承担，项目开发者不承担任何责任</p>
+<p style="color: red; font-weight: bolder;">未经同意，禁止将本项目的开源代码用于任何商业目的。因使用本项目产生的一切问题与后果由使用者自行承担，项目开发者不承担任何责任</p>
diff --git a/docs/other/timeline.md b/docs/other/timeline.md
@@ -0,0 +1,51 @@
+# 版本时间线
+
+Reaease 地址: https://github.com/ikenxuan/kkkkkk-10086/releases
+
+::: timeline v0.2.2.1
+
+### Bug Fixes
+* 修复 `#kkk设置`
+
+**Full Changelog**: [`v0.2.2...v0.2.2.1`](https://github.com/ikenxuan/kkkkkk-10086/compare/v0.2.2...v0.2.2.1)
+:::
+
+
+::: timeline v0.2.2
+### What's Changed
+* feat:  添加 `#kkk设置B站动态视频发送` 由 [**@ikenxuan**](https://github.com/ikenxuan) 在 [`48cb921`](https://github.com/ikenxuan/kkkkkk-10086/commit/48cb921a2fe6c16a211f39a33932d1bde0601a83)
+* refactor: 使用 `YAML` 格式的配置文件 和 适配 [Karin Manage](https://github.com/HalcyonAlcedo/karin-plugin-manage) 由 [**@ikenxuan**](https://github.com/ikenxuan) 在 [`88fa787`](https://github.com/ikenxuan/kkkkkk-10086/commit/88fa787ea2365821deff71298ebc60f8adcd0815)
+* style: 微调UI 由 [**@ikenxuan**](https://github.com/ikenxuan) 在 [`3fb14ae`](https://github.com/ikenxuan/kkkkkk-10086/commit/3fb14ae7a4fbe8004e208195b39cdc6503ff8bf6)
+
+**Full Changelog**: [`v0.2.1...v0.2.2`](https://github.com/ikenxuan/kkkkkk-10086/compare/v0.2.1...v0.2.2)
+:::
+
+
+::: timeline v0.2.1
+### What's Changed
+* Formatting via [**@CalmLexi**](https://github.com/CalmLexi) in [`e2be6d5`](https://github.com/ikenxuan/kkkkkk-10086/commit/e2be6d56e550729cd73a0869bab4840786773da3)
+
+### Bug Fixes
+* **!!serious**: configure file modification permissions [`b693e1b`](https://github.com/ikenxuan/kkkkkk-10086/commit/b693e1b38ebc0cb0621b5d9365c906e908db3886)
+* init file [`a959644`](https://github.com/ikenxuan/kkkkkk-10086/commit/a959644e4b4d9fe294a843785e99bcd9e4941c25)
+* ...
+
+**Full Changelog**: [`v0.2.0...v0.2.1`](https://github.com/ikenxuan/kkkkkk-10086/compare/0.2.0...v0.2.1)
+:::
+
+
+::: timeline v0.2.0
+### What's Changed
+* feature: 适配Karin、Yunzai V4/V3 by [**@ikenxuan**](https://github.com/ikenxuan) in [#21](https://github.com/ikenxuan/kkkkkk-10086/pull/21)
+* feature: 处理不同机器人框架的自定义模块 via [**@XasYer**](https://github.com/XasYer) in [XasYer/Shiranai-Plugin@`b29ec03`](https://github.com/XasYer/Shiranai-Plugin/commit/b29ec034fca79cce7f26d55b1573f3e22ecb0942) and [**@OduckO**](https://github.com/OduckO)
+
+**Full Changelog**: [`v0.1.8...v0.2.0`](https://github.com/ikenxuan/kkkkkk-10086/compare/v0.1.8...0.2.0)
+:::
+
+
+::: timeline v0.1.8
+### 新增与调整
+* 可自行选择是否上传视频（当解析的 `视频文件大小` > `设定值` 时不会上传），使用此功能需先使用 `#kkk设置上传限制开启` 后再使用 `#kkk设置限制 + 5~114514` 单位: MB
+### 修复与优化
+* 💦细节优化
+:::
diff --git a/docs/start/install.md b/docs/start/install.md
@@ -55,7 +55,7 @@ git clone --depth=1 https://mirror.ghproxy.com/https://github.com/ikenxuan/kkkkk
 - 打开 Release 页面: https://github.com/ikenxuan/kkkkkk-10086/releases
 - 找到最新的版本，下载后缀名为 `.zip` 的压缩包
 - 在 `机器人根目录/plugins/` 中解压该压缩包
-- 完成后插件应在 `机器人根目录/plugins/kkkkkk-10086/`<br>[Karin](#获取源码)则为 `机器人目录/plugins/karin-plugin-kkkkkk-10086/`
+- 完成后插件应在 `机器人根目录/plugins/kkkkkk-10086/`<br>[Karin](#获取源码) 则为 `机器人目录/plugins/karin-plugin-kkkkkk-10086/`
 
 
 

diff --git a/docs/start/start.config.md b/docs/start/start.config.md
@@ -4,16 +4,16 @@
 _**Yunzai**_ 生态用户建议使用 [**Guoba-Plugin**](https://github.com/guoba-yunzai/guoba-plugin) 进行配置文件的修改。<br>
 _**Karin**_ 生态用户建议使用 [**Karin Manage**](https://github.com/HalcyonAlcedo/karin-plugin-manage) 进行配置文件的修改
 
-``` json
+``` json{4-9}
 ├─config // 插件配置文件目录
 │  │  PluginConfigView.yaml // Karin Manage 配置文件（请勿修改该文件的任何内容！）
 │  │
-│  ├─config // 用户配置文件目录
-│  │      app.yaml // 插件应用配置
-│  │      bilibili.yaml // B站相关配置
-│  │      cookies.yaml // 账号Cookies相关配置
-│  │      douyin.yaml // 抖音相关配置
-│  │      pushlist.yaml // 推送列表相关配置
+│  ├─config // 用户配置文件目录 // [!code focus]
+│  │      app.yaml // 插件应用配置 // [!code focus]
+│  │      bilibili.yaml // B站相关配置 // [!code focus]
+│  │      cookies.yaml // 账号Cookies相关配置 // [!code focus]
+│  │      douyin.yaml // 抖音相关配置 // [!code focus]
+│  │      pushlist.yaml // 推送列表相关配置 // [!code focus]
 │  │
 │  └─default_config // 默认配置文件目录（请勿修改此目录下的任何文件！）
 │          app.yaml // 含义同上
@@ -25,4 +25,4 @@ _**Karin**_ 生态用户建议使用 [**Karin Manage**](https://github.com/Halcy
 
 # TODO
 
-已完成！~~后续版本将使用 `YAML` 格式配置文件，方便配置文件的修改。~~
+- [x] 后续版本将使用 `YAML` 格式配置文件<br>由 [**@ikenxuan**](https://github.com/ikenxuan) 在 [**88fa787**](https://github.com/ikenxuan/kkkkkk-10086/commit/88fa787ea2365821deff71298ebc60f8adcd0815) 完成
Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,4 +23,4 @@

		## TODO

		已完成！~~往后可能会根据配置文件内容进行内容渲染，而不是通过数据库缓存~~
		- [x] 往后可能会根据配置文件内容进行内容渲染，而不是通过数据库缓存<br>由 [@ikenxuan](https://github.com/ikenxuan) 在 [95dcffa](https://github.com/ikenxuan/kkkkkk-10086/commit/95dcffab00f8afc1484a1e350911636b2d92006d) 完成