docs: 美化文档

This commit is contained in:
远野千束 2024-03-31 10:59:17 +08:00
parent c80919ff1e
commit 41e389d690
9 changed files with 117 additions and 18 deletions

View File

@ -1,7 +1,16 @@
<div align="center">
<img src="https://cdn.liteyuki.icu/static/img/logo.png" style="align-content: center; width: 50%; margin-top:10%;" alt="a">
[//]: # (<img src="https://cdn.liteyuki.icu/static/img/logo.png" style="align-content: center; width: 50%; margin-top:10%;" alt="a">)
![][banner]
<h2> <span style="color: #a2d8f4">轻雪</span> <span style="color: #d0e9ff">6.2</span></h2>
<h4> <span style="color: #a2d8f4"> 轻量,高效,易于扩展</span></h4>
[![][OneBot]][onebot-link]
[![][Nonebot2]][nonebot-link]
[![][Liteyuki6.0]][lightyuki-link]
[![][Python3.10+]][python-link]
[![][Usage]][usage-link]
</div>
- 基于[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

View File

@ -23,7 +23,8 @@ export default defineUserConfig({
]
],
theme,
// 和 PWA 一起启用
// shouldPrefetch: false,
});
});

View File

@ -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: 使用<code>npm</code>,无需命令行操作即可安装/卸载插件
- 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: 使用 <code>pip install -r requirements.txt</code> 安装项目依赖。
details: 如果你有多个 Python 环境,请使用 <code>pythonx -m pip install -r requirements.txt</code>
- title: 使用 <code>python main.py</code> 启动项目。
copyright: false
copyright: © 2021-2024 SnowyKami All Rights Reserved
---

View File

@ -1,6 +1,6 @@
---
title: 配置
icon: object-group
icon: cog
order: 2
category: 使用指南
tag:

View File

@ -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的开发者
使用其他项目连接请先自行查阅文档若有困难请联系对应开发者而不是Liteyuki的开发者
### 鸣谢
- 此项目使用了[nonebot-plugin-htmlrender](https://github.com/kexue-z/nonebot-plugin-htmlrender/tree/master)作为内置html渲染插件
- TRSS_Liteyuki轻雪机器人管理脚本

View File

@ -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官方提供的功能

View File

@ -1,6 +1,6 @@
---
title: 用户协议
icon: laptop-code
icon: user-secret
order: 3
category: 使用手册
---

View File

@ -1,6 +1,6 @@
---
title: 基础命令
icon: laptop-code
icon: comment
order: 1
category: 使用手册
---

View File

@ -1,6 +1,6 @@
---
title: 功能命令
icon: laptop-code
icon: comment
order: 2
category: 使用手册
---