65 lines
943 B
Markdown
65 lines
943 B
Markdown
# @aomao/plugin-hr
|
||
|
||
分割线插件
|
||
|
||
## 安装
|
||
|
||
```bash
|
||
$ yarn add @aomao/plugin-hr
|
||
```
|
||
|
||
添加到引擎
|
||
|
||
```ts
|
||
import Engine, { EngineInterface } from '@aomao/engine';
|
||
import Hr , { HrComponent } from '@aomao/plugin-hr';
|
||
|
||
new Engine(...,{ plugins:[Hr] , cards:[HrComponent]})
|
||
```
|
||
|
||
## 可选项
|
||
|
||
### 快捷键
|
||
|
||
默认快捷键 `mod+shift+e`
|
||
|
||
```ts
|
||
hotkey?:string;//默认mod+shift+e
|
||
|
||
//使用配置
|
||
new Engine(...,{
|
||
config:{
|
||
"hr":{
|
||
//修改快捷键
|
||
hotkey:"快捷键"
|
||
}
|
||
}
|
||
})
|
||
```
|
||
|
||
### Markdown
|
||
|
||
默认支持 markdown，传入`false`关闭
|
||
|
||
Hr 插件 markdown 语法为`---`
|
||
|
||
```ts
|
||
markdown?: boolean;//默认开启，false 关闭
|
||
//使用配置
|
||
new Engine(...,{
|
||
config:{
|
||
"hr":{
|
||
//关闭markdown
|
||
markdown:false
|
||
}
|
||
}
|
||
})
|
||
```
|
||
|
||
## 命令
|
||
|
||
```ts
|
||
//可携带两个参数，语言类型，默认文本，都是可选的
|
||
engine.command.execute('hr');
|
||
```
|