diff --git a/README.md b/README.md index c278b6c2..48912bf1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@
-a + +[//]: # (a) +![][banner]

轻雪 6.2

轻量，高效，易于扩展

+ +[![][OneBot]][onebot-link] +[![][Nonebot2]][nonebot-link] +[![][Liteyuki6.0]][lightyuki-link] +[![][Python3.10+]][python-link] +[![][Usage]][usage-link] +
- 基于[Nonebot2](https://github.com/nonebot/nonebot2)，有良好的生态支持 @@ -10,7 +19,17 @@ - 全新可视化`npm`包管理，支持一键安装插件 - 支持OneBotv11/12标准通信，且使用`Alconna`命令解析，不再局限于OneBot -### [使用文档](https://bot.liteyuki.icu) -#### 鸣谢 -- 此项目使用了[nonebot-plugin-htmlrender](https://github.com/kexue-z/nonebot-plugin-htmlrender/tree/master)作为内置html渲染插件 +[OneBot]: https://img.shields.io/badge/OneBot-11/12-blue?style=for-the-badge +[Nonebot2]: https://img.shields.io/badge/Nonebot-2-red?style=for-the-badge +[Liteyuki6.0]: https://img.shields.io/badge/Liteyuki-6.0-blue?style=for-the-badge +[Python3.10+]: https://img.shields.io/badge/Python-3.10+-blue?style=for-the-badge +[Usage]: https://img.shields.io/badge/文档-页面-blue?style=for-the-badge + +[onebot-link]:https://onebot.dev/ +[nonebot-link]:https://nonebot.dev/ +[lightyuki-link]:/ +[python-link]:https://www.python.org/ +[usage-link]:https://bot.liteyuki.icu/ + +[banner]: https://socialify.git.ci/snowykami/LiteyukiBot/image?description=1&forks=1&issues=1&Plus&pulls=1&stargazers=1&theme=Auto&logo=https%3A%2F%2Fcdn.liteyuki.icu%2Fstatic%2Fimg%2Flogo.png diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index bbce39bd..23b37985 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -23,7 +23,8 @@ export default defineUserConfig({ ] ], + theme, // 和 PWA 一起启用 // shouldPrefetch: false, -}); +}); \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 081ee010..866d0b30 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,20 +3,22 @@ home: true icon: home title: 首页 heroImage: https://cdn.liteyuki.icu/static/img/logo.png -bgImage: -bgImageDark: +bgImage: +bgImageDark: bgImageStyle: background-attachment: fixed heroText: LiteyukiBot 6 tagline: 基于Nonebot2的OneBot标准聊天机器人，不仅仅局限于OneBot + actions: - - text: 部署 + - text: 快速开始 icon: lightbulb - link: ./deployment/ + link: ./deployment/install.html type: primary - text: 使用手册 - link: ./usage/ + icon: book + link: ./usage/basic_command.html #1. 安装 `Git` 和 `Python3.10+` 环境 #2. 克隆项目 `git clone https://github.com/snowykami/LiteyukiBot` (无法连接可以用`https://gitee.com/snowykami/LiteyukiBot`) @@ -25,6 +27,68 @@ actions: #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 @@ -37,5 +101,5 @@ highlights: - title: 使用 pip install -r requirements.txt 安装项目依赖。 details: 如果你有多个 Python 环境，请使用 pythonx -m pip install -r requirements.txt。 - title: 使用 python main.py 启动项目。 -copyright: false +copyright: © 2021-2024 SnowyKami All Rights Reserved --- \ No newline at end of file diff --git a/docs/deployment/config.md b/docs/deployment/config.md index 8cb37e51..e7a94333 100644 --- a/docs/deployment/config.md +++ b/docs/deployment/config.md @@ -1,6 +1,6 @@ --- title: 配置 -icon: object-group +icon: cog order: 2 category: 使用指南 tag: diff --git a/docs/deployment/fandq.md b/docs/deployment/fandq.md index c9d02e10..2328caf2 100644 --- a/docs/deployment/fandq.md +++ b/docs/deployment/fandq.md @@ -1,6 +1,6 @@ --- title: 答疑 -icon: object-group +icon: question order: 3 category: 使用指南 tag: @@ -38,4 +38,8 @@ tag: 1. [MinecraftOneBot](https://github.com/snowykami/MinecraftOnebot)，我们专门为Minecraft开发的服务器Bot，支持OneBotV11标准 -使用其他项目连接请先自行查阅文档，若有困难请联系对应开发者而不是Liteyuki的开发者 \ No newline at end of file +使用其他项目连接请先自行查阅文档，若有困难请联系对应开发者而不是Liteyuki的开发者 + +### 鸣谢 +- 此项目使用了[nonebot-plugin-htmlrender](https://github.com/kexue-z/nonebot-plugin-htmlrender/tree/master)作为内置html渲染插件 +- TRSS_Liteyuki轻雪机器人管理脚本 \ No newline at end of file diff --git a/docs/deployment/install.md b/docs/deployment/install.md index ea1b9f8c..bfe27f2c 100644 --- a/docs/deployment/install.md +++ b/docs/deployment/install.md @@ -1,14 +1,25 @@ --- title: 安装 -icon: object-group +icon: download order: 1 category: 使用指南 tag: - 安装 --- +### 设备要求 +- Windows系统版本最低`Windows10+`/`Windows Server 2019+` +- Linux系统要支持Python3.10+，推荐`Ubuntu 20.04+`/`CentOS 8+` +- CPU: 至少`1vCPU` +- 内存: Bot无其他插件会占用`100MB`，其他插件占用视具体插件而定，建议`1GB`以上 +- 硬盘: 至少`1GB`空间 +- GPU: 原生轻雪无需GPU，某些插件需要GPU支持，例如AI绘画之类的，具体查看插件文档 + +### 开始安装 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` + +#### 想在Linux命令行中拥有更好的体验？试试[TRSS_Liteyuki轻雪机器人管理脚本](https://timerainstarsky.github.io/TRSS_Liteyuki/)，该功能仅供参考，不是LiteyukiBot官方提供的功能 diff --git a/docs/usage/agreement.md b/docs/usage/agreement.md index 8edb991a..52122820 100644 --- a/docs/usage/agreement.md +++ b/docs/usage/agreement.md @@ -1,6 +1,6 @@ --- title: 用户协议 -icon: laptop-code +icon: user-secret order: 3 category: 使用手册 --- diff --git a/docs/usage/basic_command.md b/docs/usage/basic_command.md index ea4838b7..14a67867 100644 --- a/docs/usage/basic_command.md +++ b/docs/usage/basic_command.md @@ -1,6 +1,6 @@ --- title: 基础命令 -icon: laptop-code +icon: comment order: 1 category: 使用手册 --- diff --git a/docs/usage/extra_command.md b/docs/usage/extra_command.md index bd6359d8..f35d4a2b 100644 --- a/docs/usage/extra_command.md +++ b/docs/usage/extra_command.md @@ -1,6 +1,6 @@ --- title: 功能命令 -icon: laptop-code +icon: comment order: 2 category: 使用手册 ---