67 lines
1.0 KiB
Markdown
67 lines
1.0 KiB
Markdown
|
# @aomao/plugin-sup
|
||
|
|
|
||
|
|
Superscript style plugin
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ yarn add @aomao/plugin-sup
|
||
|
|
```
|
||
|
|
|
||
|
|
Add to engine
|
||
|
|
|
||
|
|
```ts
|
||
|
|
import Engine, {EngineInterface} from'@aomao/engine';
|
||
|
|
import Sup from'@aomao/plugin-sup';
|
||
|
|
|
||
|
|
new Engine(...,{ plugins:[Sup] })
|
||
|
|
```
|
||
|
|
|
||
|
|
## Optional
|
||
|
|
|
||
|
|
### hot key
|
||
|
|
|
||
|
|
The default shortcut key is `mod+.`, multiple shortcut keys are passed in as an array
|
||
|
|
|
||
|
|
```ts
|
||
|
|
//hot key,
|
||
|
|
hotkey?: string | Array<string>;
|
||
|
|
|
||
|
|
//Use configuration
|
||
|
|
new Engine(...,{
|
||
|
|
config:{
|
||
|
|
"sup":{
|
||
|
|
//Modify shortcut keys
|
||
|
|
hotkey: "shortcut key"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
})
|
||
|
|
```
|
||
|
|
|
||
|
|
### Markdown
|
||
|
|
|
||
|
|
Support markdown by default, pass in `false` to close
|
||
|
|
|
||
|
|
Sup plugin markdown syntax is `^`
|
||
|
|
|
||
|
|
```ts
|
||
|
|
markdown?: boolean;//enabled by default, false off
|
||
|
|
//Use configuration
|
||
|
|
new Engine(...,{
|
||
|
|
config:{
|
||
|
|
"sup":{
|
||
|
|
//Close markdown
|
||
|
|
markdown:false
|
||
|
|
}
|
||
|
|
}
|
||
|
|
})
|
||
|
|
```
|
||
|
|
|
||
|
|
## Command
|
||
|
|
|
||
|
|
```ts
|
||
|
|
engine.command.execute('sup');
|
||
|
|
//Use command to execute query current status, return boolean | undefined
|
||
|
|
engine.command.queryState('sup');
|
||
|
|
```
|