Skip to content

Commit a812def

Browse files
committed
feat(ecosystem): add action plugin documentation and sidebar entry
- Introduced a new sidebar entry for the action plugin in the ecosystem section. - Added comprehensive documentation for the action plugin, detailing configuration options and usage instructions. - Included an image to enhance the documentation's clarity.
1 parent ee7e455 commit a812def

File tree

3 files changed

+134
-0
lines changed

3 files changed

+134
-0
lines changed

docs/.vitepress/config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,10 @@ function sidebarEcosystem(): DefaultTheme.SidebarItem[] {
646646
text: "角色卡兼容 (Character Card)",
647647
link: "/ecosystem/extension/character-card",
648648
},
649+
{
650+
text: "动作 (Action)",
651+
link: "/ecosystem/extension/action",
652+
},
649653
],
650654
},
651655
{

docs/ecosystem/extension/action.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# 动作 (Action)
2+
3+
此插件可以自定义插件命令,传递指定的提示词给 ChatLuna 调用。并且可以拦截命令输出,调用 ChatLuna 来进行文字二次渲染。
4+
5+
## 配置
6+
7+
* 前往插件市场搜索 `chatluna-actions` 并安装。
8+
9+
![alt text](../../public/images/image-83.png)
10+
11+
完成完成后直接启用插件即可。
12+
13+
## 使用
14+
15+
参考下面的插件配置,配置插件即可。
16+
17+
配置完成后记得启用插件,才能选择模型。
18+
19+
## 配置项
20+
21+
此处列举了 `chatluna-actions` 插件的配置项。
22+
23+
### 命令配置
24+
25+
#### command
26+
27+
* 类型:`string`
28+
* 默认值:无
29+
* 描述:注册的一级命令名称
30+
31+
#### model
32+
33+
* 类型:`string`
34+
* 默认值:无
35+
* 描述:执行命令时使用的模型
36+
37+
#### enabled
38+
39+
* 类型:`boolean`
40+
* 默认值:`false`
41+
* 描述:是否启用此命令
42+
43+
#### description
44+
45+
* 类型:`string`
46+
* 默认值:无
47+
* 描述:命令的描述
48+
49+
#### chatMode
50+
51+
* 类型:`chat|plugin`
52+
53+
* 默认值:`chat`
54+
* 描述:聊天模式(chat: 聊天模式, plugin: 插件模式)
55+
56+
#### promptType
57+
58+
* 类型:`Instruction|preset`
59+
* 默认值:`Instruction`
60+
* 描述:提示词类型(Instruction: 指令, preset: 预设)
61+
62+
#### preset
63+
64+
* 类型:`string`
65+
* 默认值:无
66+
* 描述:选择的预设
67+
68+
#### prompt
69+
70+
* 类型:`string`
71+
* 默认值:无
72+
* 描述:自定义提示词
73+
* 说明:留空用户会自由输入,如设定不为空则使用设定值。
74+
75+
### 拦截命令配置
76+
77+
#### interceptCommands
78+
79+
* 类型:`string[]`
80+
* 默认值:无
81+
* 描述:拦截的命令列表
82+
83+
#### interceptPosition
84+
85+
* 类型:`string`
86+
* 默认值:无
87+
* 描述:拦截的位置(after: 命令执行后, before: 命令执行前)
88+
89+
#### interceptEnabled
90+
91+
* 类型:`boolean`
92+
* 默认值:`false`
93+
* 描述:是否启用此拦截命令配置
94+
95+
#### interceptModel
96+
97+
* 类型:`string`
98+
* 默认值:无
99+
* 描述:执行拦截命令时使用的模型
100+
101+
#### interceptCommand
102+
103+
* 类型:`string`
104+
* 默认值:无
105+
* 描述:拦截的命令名称
106+
107+
#### interceptChatMode
108+
109+
* 类型:`chat|plugin`
110+
* 默认值:`chat`
111+
* 描述:聊天模式(chat: 聊天模式, plugin: 插件模式)
112+
113+
#### interceptPromptType
114+
115+
* 类型:`Instruction|preset`
116+
* 默认值:`Instruction`
117+
* 描述:提示词类型(Instruction: 指令, preset: 预设)
118+
119+
#### interceptPreset
120+
121+
* 类型:`string`
122+
* 默认值:无
123+
* 描述:选择的预设
124+
125+
#### interceptPrompt
126+
127+
* 类型:`string`
128+
* 默认值:无
129+
* 描述:自定义提示词
130+
* 说明:拦截命令输入文本

docs/public/images/image-83.png

35.4 KB
Loading

0 commit comments

Comments
 (0)