67 lines
996 B
Markdown
67 lines
996 B
Markdown
# @aomao/plugin-sub
|
||
|
||
下标样式插件
|
||
|
||
## 安装
|
||
|
||
```bash
|
||
$ yarn add @aomao/plugin-sub
|
||
```
|
||
|
||
添加到引擎
|
||
|
||
```ts
|
||
import Engine, { EngineInterface } from '@aomao/engine';
|
||
import Sub from '@aomao/plugin-sub';
|
||
|
||
new Engine(...,{ plugins:[Sub] })
|
||
```
|
||
|
||
## 可选项
|
||
|
||
### 快捷键
|
||
|
||
默认快捷键为 `mod+,`，以数组形式传入多个快捷键
|
||
|
||
```ts
|
||
//快捷键，
|
||
hotkey?: string | Array<string>;
|
||
|
||
//使用配置
|
||
new Engine(...,{
|
||
config:{
|
||
"sub":{
|
||
//修改快捷键
|
||
hotkey:"快捷键"
|
||
}
|
||
}
|
||
})
|
||
```
|
||
|
||
### Markdown
|
||
|
||
默认支持 markdown，传入`false`关闭
|
||
|
||
Sub 插件 markdown 语法为`~`
|
||
|
||
```ts
|
||
markdown?: boolean;//默认开启，false 关闭
|
||
//使用配置
|
||
new Engine(...,{
|
||
config:{
|
||
"sub":{
|
||
//关闭markdown
|
||
markdown:false
|
||
}
|
||
}
|
||
})
|
||
```
|
||
|
||
## 命令
|
||
|
||
```ts
|
||
engine.command.execute('sub');
|
||
//使用 command 执行查询当前状态，返回 boolean | undefined
|
||
engine.command.queryState('sub');
|
||
```
|