Skip to content

Commit c8916ba

Browse files
AzideCupricfelinae98
authored andcommitted
📝 添加 Theme 配置相关文档
1 parent 5fc5e29 commit c8916ba

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

docs/usage/README.md

+49
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,23 @@ next: /usage/easy-use
7474
- `BISON_PROXY`: 使用的代理连接,形如`http://<ip>:<port>`(可选)
7575
- `BISON_UA`: 使用的 User-Agent,默认为 Chrome
7676
- `BISON_SHOW_NETWORK_WARNING`: 是否在日志中输出网络异常,默认为`True`
77+
- `BISON_THEME_USE_BROWSER`: 是否使用浏览器渲染主题,某些主题可能需要浏览器渲染(htmlrender),默认为`False`
78+
- `BISON_PLATFORM_THEME`: 为[平台](#平台)指定渲染用[主题](#主题),用于渲染推送消息,默认为`{}`
79+
::: details BISON_PLATFORM_THEME 配置项示例
80+
81+
配置项使用`<platform>:<theme>`的形式来为某个平台指定其渲染主题,例如`"weibo":"basic"``"bilibili":"ht2i"`
82+
最外层使用`{}`包裹,多个配置项之间使用逗号`,`分隔。
83+
需要注意,`<platform>`所用内容是平台的**英文名**`<theme>`所用内容是主题的**英文名**。并且不要忘记使用双引号`""`包裹内容。
84+
85+
例子:
86+
87+
```env
88+
BISON_PLATFORM_THEME={"weibo":"basic","bilibili":"ht2i"}
89+
```
90+
91+
所有支持的平台请参见[平台](#平台)一节
92+
所有支持的主题请参见[主题](#主题)一节
93+
:::
7794

7895
## 使用
7996

@@ -150,6 +167,38 @@ Command(命令):
150167
--help 显示帮助
151168
```
152169

170+
### 平台
171+
172+
Bison 支持的平台如下:
173+
174+
- arknights: 明日方舟游戏信息
175+
- bilibili: B站
176+
- bilibili-live: Bilibili直播
177+
- bilibili-bangumi: Bilibili剧集
178+
- ff14: 最终幻想XIV官方公告
179+
- mcbbsnews: MCBBS幻翼块讯
180+
- ncm-artist: 网易云-歌手
181+
- ncm-radio: 网易云-电台
182+
- rss: RSS
183+
- weibo: 新浪微博
184+
185+
:::tip
186+
配置 `BISON_PLATFORM_THEME` 时,所用的 `<platform>``:` 左边的值
187+
:::
188+
189+
### 主题
190+
191+
Bison 支持的主题如下:
192+
193+
- basic: 基础主题,是每个平台都会支持的主题
194+
- ht2i: 使用 `nonebot-plugin-htmlrender` 插件,将文本渲染成图片的主题
195+
- brief: 简报主题,仅发送标题、链接、图片
196+
- arknights: 明日方舟专用主题,渲染为明日方舟公告风格
197+
198+
:::tip
199+
配置 `BISON_PLATFORM_THEME` 时,所用的 `<theme>``:` 左边的值
200+
:::
201+
153202
### 所支持平台的 uid
154203

155204
#### Weibo

0 commit comments

Comments
 (0)