yykj-markdown-it
v0.0.3-beta.2
Published
银雁科技AIGC MarkdownIt组件
Downloads
572
Readme
自定义 Markdown-it 插件
多项目使用统一流程,封装组件统一处理。
使用方法
- 安装依赖包
# 使用 npm 安装
npm install yykj-markdown-it
# 使用 pnpm 安装
pnpm install yykj-markdown-it
- 引入依赖包及css样式
import CreateMarkdownIt from 'yykj-markdown-it'
import 'yykj-markdown-it/lib/es/style.css'
const md = CreateMarkdownIt()
- 使用
const md = CreateMarkdownIt()
- 参数
CustomMarkdownItOptions
|参数|说明|类型|默认值|必填| |-|-|-|-|-| |plugins|markdown-it插件集合|PluginSimple[]|[]|可选| |showTitle|是否展示标题栏|boolean|true|可选| |showCopyBtn|是否展示标题栏的复制按钮|boolean|false|可选| |copyTip|复制按钮的原生提示内容|string|复制|可选| |html|是否转换html标签|boolean|true|可选| |breaks|是否转换\n|boolean|true|可选| |style|自定义样式|ContainerStyle|-|可选|
ContainerStyle
|参数|说明|类型|默认值|必填| |-|-|-|-|-| |containerClass|容器类样式|string|code-container|可选| |containerStyle|容器内联样式|string|-|可选| |iconClass|右侧复制图标类样式|string|code-icon|可选| |iconStyle|右侧复制图标内联样式|string|-|可选| |buttonClass|右侧复制按钮类样式|string|md-copy-btn|可选| |buttonStyle|右侧复制按钮内联样式|string|-|可选| |titleContainerClass|标题容器类样式|string|code-title-container|可选| |titleContainerStyle|标题容器内联样式|string|-|可选|