am-editor-002/plugins/code/README.md

67 lines
1013 B
Markdown
Raw Normal View History

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