am-editor11212/plugins/strikethrough
yanmao 17cb84afa0 feat: add card mark style 2021-12-24 00:45:49 +08:00
..
src feat: add card mark style 2021-12-24 00:45:49 +08:00
README.md init 2021-11-03 19:58:08 +08:00
package.json feat: add card mark style 2021-12-24 00:45:49 +08:00
tsconfig.json init 2021-11-03 19:58:08 +08:00

README.md

@aomao/plugin-strikethrough

删除线样式插件

安装

$ yarn add @aomao/plugin-strikethrough

添加到引擎

import Engine, { EngineInterface } from '@aomao/engine';
import Strikethrough from '@aomao/plugin-strikethrough';

new Engine(...,{ plugins:[Strikethrough] })

可选项

快捷键

默认快捷键为 mod+shift+x,以数组形式传入多个快捷键

//快捷键,
hotkey?: string | Array<string>;

//使用配置
new Engine(...,{
    config:{
        "strikethrough":{
            //修改快捷键
            hotkey:"快捷键"
        }
    }
 })

Markdown

默认支持 markdown传入false关闭

Strikethrough 插件 markdown 语法为~~

markdown?: boolean;//默认开启false 关闭
//使用配置
new Engine(...,{
    config:{
        "strikethrough":{
            //关闭markdown
            markdown:false
        }
    }
 })

命令

engine.command.execute('strikethrough');
//使用 command 执行查询当前状态,返回 boolean | undefined
engine.command.queryState('strikethrough');