From e97bd0a50b2565705379c73f0b8955ebe1aed44b Mon Sep 17 00:00:00 2001 From: snowy Date: Mon, 1 Apr 2024 13:33:21 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=84=9A=E4=BA=BA=E8=8A=82=E5=BF=AB?= =?UTF-8?q?=E4=B9=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.md | 46 +++++++++--------- docs/README_normal.md | 105 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 128 insertions(+), 23 deletions(-) create mode 100644 docs/README_normal.md diff --git a/docs/README.md b/docs/README.md index c27d2f0..0377e2d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ bgImageDark: bgImageStyle: background-attachment: fixed heroText: HeavyyukiBot666 # LiteyukiBot 6 -tagline: 重雪机器人，一个以笨重和复杂为设计理念基于Nonebot114514的OneBotv1919810标准聊天机器人，可用于雪地清扫 +tagline: 重雪机器人，一个以笨重和复杂为设计理念基于Koishi114514的OneBotv1919810标准聊天机器人，可用于雪地清扫 #tagline: 轻雪机器人，一个以轻量和简洁为设计理念基于Nonebot2的OneBot标准聊天机器人 actions: @@ -17,7 +17,7 @@ actions: link: ./deployment/install.html type: primary - - text: 小册子 # 使用手册 + - text: 奇怪的册子 # 使用手册 icon: book link: ./usage/basic_command.html @@ -37,70 +37,70 @@ highlights: background-repeat: repeat background-size: initial features: - - title: 基于Nonebot2 + - title: 基于Koishi.js233 icon: robot details: 拥有良好的生态支持 link: https://nonebot.dev/ - - title: 可视化插件管理 + - title: 盲目插件管理 icon: plug - details: 使用npm，无需命令行操作即可安装/卸载插件 + details: 基于nbshi使用npmx和pip，让你无法安装/卸载插件 - - title: 点击交互 + - title: 点击无法交互 icon: mouse-pointer - details: 新的点击交互模式，拒绝手打指令 + details: 老的的点击交互模式，必须手打指令 - - title: 主题支持 + - title: 猪蹄支持 icon: paint-brush details: 支持多种主题，可自定义资源包，满足你的审美需求 - - title: 国际化 + - title: 非国际化 icon: globe details: 支持多种语言，包括i18n部分语言和自行扩展的语言代码 link: https://baike.baidu.com/item/i18n/6771940 - - title: 简易配置 + - title: 超难配置 icon: cog details: 无需过多配置，开箱即用 link: https://bot.liteyuki.icu/deployment/config.html - - title: 低占用 + - title: 高占用 icon: memory - details: 使用更少的依赖和资源 + details: 使用更多的意义不明的依赖和资源 - - title: OneBot标准 + - title: 一个Bot标准 icon: link details: 支持OneBotv11/12标准的四种通信协议 link: https://onebot.dev/ - title: Alconna icon: link - details: 使用Alconna实现高效命令解析 + details: 使用Alconna实现低效命令解析 link: https://github.com/nonebot/plugin-alconna - - title: 便捷更新 + - title: 不准更新 icon: cloud-download - details: 聊天窗口命令更新，无需手动下载 + details: 要更新自己下新版本去 - title: 服务支持 icon: server - details: 内置轻雪API，可自动收集错误，提供图床服务 + details: 内置轻雪API，但随时可能跑路 - - title: 开源 + - title: 闭源 icon: code - details: 项目遵循MIT协议开源，欢迎各位的贡献 + details: 要源代码自己逆向去 - header: 快速部署 image: /assets/image/box.svg bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg highlights: - - title: 安装 Git 和 Python3.10+ + - title: 安装 Git 和 node.js+ - title: 使用 git clone https://github.com/snowykami/LiteyukiBot 以克隆项目至本地。 details: 如果无法连接到GitHub，可以使用 git clone https://gitee.com/snowykami/LiteyukiBot。 - title: 使用 cd LiteyukiBot 切换到项目目录。 - - title: 使用 pip install -r requirements.txt 安装项目依赖。 - details: 如果你有多个 Python 环境，请使用 pythonx -m pip install -r requirements.txt。 - - title: 使用 python main.py 启动项目。 + - title: 使用 npm install -r requirements.txt 安装项目依赖。 + details: 如果你有多个 node.js 环境，请使用 pythonx -m npm install -r requirements.txt。 + - title: 使用 node main.py 启动项目。 copyright: © 2021-2024 SnowyKami All Rights Reserved --- \ No newline at end of file diff --git a/docs/README_normal.md b/docs/README_normal.md new file mode 100644 index 0000000..dcf1a22 --- /dev/null +++ b/docs/README_normal.md @@ -0,0 +1,105 @@ +--- +home: true +icon: home +title: 首页 +heroImage: https://cdn.liteyuki.icu/static/img/logo.png +bgImage: +bgImageDark: +bgImageStyle: + background-attachment: fixed +heroText: LiteyukiBot 6 +tagline: 轻雪机器人，一个以轻量和简洁为设计理念基于Nonebot2的OneBot标准聊天机器人 + +actions: + - text: 快速开始 + icon: lightbulb + link: ./deployment/install.html + type: primary + + - text: 使用手册 + icon: book + link: ./usage/basic_command.html + +#1. 安装 `Git` 和 `Python3.10+` 环境 +#2. 克隆项目 `git clone https://github.com/snowykami/LiteyukiBot` (无法连接可以用`https://gitee.com/snowykami/LiteyukiBot`) +#3. 切换目录`cd LiteyukiBot` +#4. 安装依赖`pip install -r requirements.txt`(如果多个Python环境请指定后安装`pythonx -m pip install -r requirements.txt`) +#5. 启动`python main.py` + +highlights: + + - header: 简洁至上 + image: /assets/image/layout.svg + bgImage: https://theme-hope-assets.vuejs.press/bg/2-light.svg + bgImageDark: https://theme-hope-assets.vuejs.press/bg/2-dark.svg + bgImageStyle: + background-repeat: repeat + background-size: initial + features: + - title: 基于Nonebot2 + icon: robot + details: 拥有良好的生态支持 + link: https://nonebot.dev/ + + - title: 可视化插件管理 + icon: plug + details: 使用npm，无需命令行操作即可安装/卸载插件 + + - title: 点击交互 + icon: mouse-pointer + details: 新的点击交互模式，拒绝手打指令 + + - title: 主题支持 + icon: paint-brush + details: 支持多种主题，可自定义资源包，满足你的审美需求 + + - title: 国际化 + icon: globe + details: 支持多种语言，包括i18n部分语言和自行扩展的语言代码 + link: https://baike.baidu.com/item/i18n/6771940 + + - title: 简易配置 + icon: cog + details: 无需过多配置，开箱即用 + link: https://bot.liteyuki.icu/deployment/config.html + + - title: 低占用 + icon: memory + details: 使用更少的依赖和资源 + + - title: OneBot标准 + icon: link + details: 支持OneBotv11/12标准的四种通信协议 + link: https://onebot.dev/ + + - title: Alconna + icon: link + details: 使用Alconna实现高效命令解析 + link: https://github.com/nonebot/plugin-alconna + + - title: 便捷更新 + icon: cloud-download + details: 聊天窗口命令更新，无需手动下载 + + - title: 服务支持 + icon: server + details: 内置轻雪API，可自动收集错误，提供图床服务 + + - title: 开源 + icon: code + details: 项目遵循MIT协议开源，欢迎各位的贡献 + + - header: 快速部署 + image: /assets/image/box.svg + bgImage: https://theme-hope-assets.vuejs.press/bg/3-light.svg + bgImageDark: https://theme-hope-assets.vuejs.press/bg/3-dark.svg + highlights: + - title: 安装 Git 和 Python3.10+ + - title: 使用 git clone https://github.com/snowykami/LiteyukiBot 以克隆项目至本地。 + details: 如果无法连接到GitHub，可以使用 git clone https://gitee.com/snowykami/LiteyukiBot。 + - title: 使用 cd LiteyukiBot 切换到项目目录。 + - title: 使用 pip install -r requirements.txt 安装项目依赖。 + details: 如果你有多个 Python 环境，请使用 pythonx -m pip install -r requirements.txt。 + - title: 使用 python main.py 启动项目。 +copyright: © 2021-2024 SnowyKami All Rights Reserved +--- \ No newline at end of file