am-editor-002/plugins/codeblock-vue/README.md

1.3 KiB
Raw Blame History

@aomao/plugin-codeblock-vue

代码块插件

安装

$ yarn add @aomao/plugin-codeblock-vue

添加到引擎

import Engine, { EngineInterface } from '@aomao/engine';
import CodeBlock , { CodeBlockComponent } from '@aomao/plugin-codeblock';

new Engine(...,{ plugins:[CodeBlock] , cards:[CodeBlockComponent]})

可选项

快捷键

默认无快捷键

//快捷键key 组合键args执行参数[mode?: string, value?: string] 语言模式:可选,代码文本:可选
hotkey?:string | {key:string,args:Array<string>};//默认无

//使用配置
new Engine(...,{
    config:{
        "codeblock":{
            //修改快捷键
            hotkey:{
                key:"mod+b",
                args:["javascript","const test = 123;"]
            }
        }
    }
 })

Markdown

默认支持 markdown传入false关闭

CodeBlock 插件 markdown 语法为```

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

命令

//可携带两个参数,语言类型,默认文本,都是可选的
engine.command.execute('codeblock', 'javascript', 'const test = 123;');