mirror of
https://github.com/LiteyukiStudio/LiteyukiBot.git
synced 2024-11-22 20:17:39 +08:00
docs: Update
This commit is contained in:
parent
23353a3673
commit
db0542279b
@ -40,11 +40,11 @@ const props = defineProps({
|
|||||||
}
|
}
|
||||||
|
|
||||||
.item-card:hover {
|
.item-card:hover {
|
||||||
border: 2px solid #00a6ff;
|
border: 2px solid $themeColor;
|
||||||
}
|
}
|
||||||
|
|
||||||
.item-name {
|
.item-name {
|
||||||
color: #00a6ff;
|
color: $themeColor;
|
||||||
font-size: 20px;
|
font-size: 20px;
|
||||||
margin-bottom: 10px;
|
margin-bottom: 10px;
|
||||||
}
|
}
|
||||||
@ -58,7 +58,7 @@ const props = defineProps({
|
|||||||
.icon {
|
.icon {
|
||||||
width: 20px;
|
width: 20px;
|
||||||
height: 20px;
|
height: 20px;
|
||||||
color: #00000055;
|
color: $themeColor;
|
||||||
}
|
}
|
||||||
|
|
||||||
.author-info {
|
.author-info {
|
||||||
|
@ -62,6 +62,7 @@ export default hopeTheme({
|
|||||||
|
|
||||||
// 此处开启了很多功能用于演示,你应仅保留用到的功能。
|
// 此处开启了很多功能用于演示,你应仅保留用到的功能。
|
||||||
mdEnhance: {
|
mdEnhance: {
|
||||||
|
alert: true,
|
||||||
align: true,
|
align: true,
|
||||||
attrs: true,
|
attrs: true,
|
||||||
codetabs: true,
|
codetabs: true,
|
||||||
|
@ -58,3 +58,4 @@ custom_config_2: "custom_value2"
|
|||||||
- 实现端与轻雪的通信方式不局限为反向WebSocket,但是推荐使用反向WebSocket。
|
- 实现端与轻雪的通信方式不局限为反向WebSocket,但是推荐使用反向WebSocket。
|
||||||
- 反向WebSocket的优点是轻雪作为服务端,可以更好的控制连接,适用于生产环境。
|
- 反向WebSocket的优点是轻雪作为服务端,可以更好的控制连接,适用于生产环境。
|
||||||
- 在某些情况下,你也可以使用正向WebSocket,比如你在开发轻雪插件时,可以使用正向WebSocket主动连接实现端
|
- 在某些情况下,你也可以使用正向WebSocket,比如你在开发轻雪插件时,可以使用正向WebSocket主动连接实现端
|
||||||
|
- 有更多疑问请访问[OneBot Adapter](https://onebot.adapters.nonebot.dev/)获取详细信息
|
||||||
|
@ -9,17 +9,28 @@ tag:
|
|||||||
|
|
||||||
### 设备要求
|
### 设备要求
|
||||||
- Windows系统版本最低`Windows10+`/`Windows Server 2019+`
|
- Windows系统版本最低`Windows10+`/`Windows Server 2019+`
|
||||||
- Linux系统要支持Python3.10+,推荐`Ubuntu 20.04+`/`CentOS 8+`(~~别用你那b CentOS~~)
|
- Linux系统要支持Python3.10+,推荐`Ubuntu 20.04+`(~~别用你那b CentOS~~)
|
||||||
- CPU: 至少`1vCPU`
|
- CPU: 至少`1vCPU`
|
||||||
- 内存: Bot无其他插件会占用`100MB`,其他插件占用视具体插件而定,建议`1GB`以上
|
- 内存: Bot无其他插件会占用`200~300MB`,其他插件占用视具体插件而定,建议`1GB`以上
|
||||||
- 硬盘: 至少`1GB`空间
|
- 硬盘: 至少`1GB`空间
|
||||||
- GPU: 原生轻雪无需GPU,某些插件需要GPU支持,例如AI绘画之类的,具体查看插件文档
|
|
||||||
|
|
||||||
### 开始安装
|
### 开始安装
|
||||||
1. 安装 `Git` 和 `Python3.10+` 环境
|
1. 安装 `Git` 和 `Python3.10+` 环境
|
||||||
2. 克隆项目 `git clone https://github.com/snowykami/LiteyukiBot` (无法连接可以用`https://gitee.com/snowykami/LiteyukiBot`)
|
2. 克隆项目 `git clone https://github.com/snowykami/LiteyukiBot`
|
||||||
3. 切换目录`cd LiteyukiBot`
|
3. 切换目录`cd LiteyukiBot`
|
||||||
4. 安装依赖`pip install -r requirements.txt`(如果多个Python环境请指定后安装`pythonx -m pip install -r requirements.txt`)
|
4. 安装依赖`pip install -r requirements.txt`
|
||||||
5. 启动`python main.py`
|
5. 启动`python main.py`
|
||||||
|
|
||||||
|
> [!warning]
|
||||||
|
> 请确保你的Python环境正确,如果设备上有多个环境,请使用`path/to/python -m pip install -r requirements.txt`来安装依赖,`path/to/python`为你的Python可执行文件路径
|
||||||
|
|
||||||
|
> [!tip]
|
||||||
|
> 推荐使用虚拟环境来运行轻雪,以避免依赖冲突,你可以使用`python -m venv venv`来创建虚拟环境,然后使用`venv\Scripts\activate`来激活虚拟环境
|
||||||
|
|
||||||
|
> [!warning]
|
||||||
|
> 轻雪的更新功能依赖Git,如果你没有安装Git,你将无法使用更新功能
|
||||||
|
>
|
||||||
|
|
||||||
|
#### 其他问题请移步至[答疑](/deployment/fandq)
|
||||||
|
|
||||||
#### 想在Linux命令行中拥有更好的体验?试试[TRSS_Liteyuki轻雪机器人管理脚本](https://timerainstarsky.github.io/TRSS_Liteyuki/),该功能仅供参考,不是LiteyukiBot官方提供的功能
|
#### 想在Linux命令行中拥有更好的体验?试试[TRSS_Liteyuki轻雪机器人管理脚本](https://timerainstarsky.github.io/TRSS_Liteyuki/),该功能仅供参考,不是LiteyukiBot官方提供的功能
|
||||||
|
@ -73,12 +73,8 @@ enable 启用 | disable 停用 | enable-global 全局启用 | disable-global 全
|
|||||||
rpm 资源包 | load 加载 | unload 卸载 | change 更改 | reload 重载 | list 列表
|
rpm 资源包 | load 加载 | unload 卸载 | change 更改 | reload 重载 | list 列表
|
||||||
```
|
```
|
||||||
|
|
||||||
```shell
|
> [!warning]
|
||||||
|
> 受限于NoneBot2钩子函数的依赖注入参数,插件停用只能阻断传入响应,对于主动推送的插件不生效,请阅读插件主页的说明。
|
||||||
# 受限于Nonebot的钩子函数,目前只能阻断消息事件的传入,对于主动推送消息的插件,无法将其阻止
|
|
||||||
------
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### **用户管理`liteyuki_user`**
|
### **用户管理`liteyuki_user`**
|
||||||
|
|
||||||
@ -95,6 +91,7 @@ profile get <key> # 获取用户信息
|
|||||||
profile 个人信息 | set 设置 | get 查询
|
profile 个人信息 | set 设置 | get 查询
|
||||||
```
|
```
|
||||||
|
|
||||||
**参数**:`<param>`为必填参数,`[option]`为可选参数。
|
> [!tip]
|
||||||
|
> **参数**:`<param>`为必填参数,`[option]`为可选参数。
|
||||||
**命令别名**:配置了命令别名的命令可以使用别名代替原命令,例如`npm install ~`可以使用`插件 安装 ~`代替。
|
>
|
||||||
|
> **命令别名**:配置了命令别名的命令可以使用别名代替原命令,例如`npm install ~`可以使用`插件 安装 ~`代替。
|
||||||
|
@ -8,7 +8,7 @@ category: 使用手册
|
|||||||
## 简介
|
## 简介
|
||||||
资源包,亦可根据用途称为主题包、字体包、语言包等,它允许你一定程度上自定义轻雪的外观,并且不用修改源代码
|
资源包,亦可根据用途称为主题包、字体包、语言包等,它允许你一定程度上自定义轻雪的外观,并且不用修改源代码
|
||||||
- [资源/主题商店](/store/)提供了一些资源包供你选择,你也可以自己制作资源包
|
- [资源/主题商店](/store/)提供了一些资源包供你选择,你也可以自己制作资源包
|
||||||
- 资源包的制作很简单,如果你接触过`Minecraft`的资源包,那么你能够很快就上手,仅需按照原有路径进行文件替换即刻,讲起打包成一个新的资源包。
|
- 资源包的制作很简单,如果你接触过`Minecraft`的资源包,那么你能够很快就上手,仅需按照原有路径进行文件替换即可,讲起打包成一个新的资源包。
|
||||||
- 部分内容制作需要一点点前端基础,例如`html`,`css`
|
- 部分内容制作需要一点点前端基础,例如`html`,`css`
|
||||||
- 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`,可以在此基础上进行修改
|
- 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`,可以在此基础上进行修改
|
||||||
- 欢迎各位投稿资源包到轻雪资源商店
|
- 欢迎各位投稿资源包到轻雪资源商店
|
||||||
|
@ -260,3 +260,58 @@ class Markdown:
|
|||||||
for char in chars:
|
for char in chars:
|
||||||
text = text.replace(char, f"\\\\{char}")
|
text = text.replace(char, f"\\\\{char}")
|
||||||
return text
|
return text
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def H1(text: str, end="\n") -> str:
|
||||||
|
"""H1标题"""
|
||||||
|
return f"# {text}{end}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def H2(text: str, end="\n") -> str:
|
||||||
|
"""H2标题"""
|
||||||
|
return f"## {text}{end}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def H3(text: str, end="\n") -> str:
|
||||||
|
"""H3标题"""
|
||||||
|
return f"### {text}{end}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def H4(text: str, end="\n") -> str:
|
||||||
|
"""H4标题"""
|
||||||
|
return f"#### {text}{end}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def H5(text: str, end="\n") -> str:
|
||||||
|
"""H5标题"""
|
||||||
|
return f"##### {text}{end}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def H6(text: str, end="\n") -> str:
|
||||||
|
"""H6标题"""
|
||||||
|
return f"###### {text}{end}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def Bold(text: str) -> str:
|
||||||
|
"""加粗"""
|
||||||
|
return f"**{text}**"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def Italic(text: str) -> str:
|
||||||
|
"""斜体"""
|
||||||
|
return f"*{text}*"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def BoldItalic(text: str) -> str:
|
||||||
|
"""粗斜体"""
|
||||||
|
return f"***{text}***"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def Underline(text: str) -> str:
|
||||||
|
"""下划线"""
|
||||||
|
return f"__{text}__"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def Strike(text: str) -> str:
|
||||||
|
"""删除线"""
|
||||||
|
return f"~~{text}~~"
|
||||||
|
Loading…
Reference in New Issue
Block a user