@jsonlee_12138/markdown-it-mermaid v0.0.6

Markdown-It-Mermaid

English document

介绍

markdown-it-mermaid 是一个用于在 markdown-it 中渲染 Mermaid 图表的插件。通过此插件，您可以在 Markdown 文件中直接书写 Mermaid 代码块，并将其渲染为图表。

安装

# 使用 npm
npm install @jsonlee_12138/markdown-it-mermaid --save

# 使用 yarn
yarn add @jsonlee_12138/markdown-it-mermaid

# 使用 pnpm
pnpm add @jsonlee_12138/markdown-it-mermaid

基础使用

import MarkdownIt from 'markdown-it';
import markdownItMermaid from '@jsonlee_12138/markdown-it-mermaid';

const md = new MarkdownIt();
// delay默认为30ms, 用于延迟渲染，防止打字机闪动, 非必传
md.use(markdownItMermaid({ delay: 100 }));

const result = md.render(`
\`\`\`mermaid
graph TD
  A[Client] --> B[Load Balancer]
  B --> C[Server01]
  B --> D[Server02]
\`\`\`
`);

// 输出结果为 HTML 格式，其中包含 Mermaid 图表的渲染结果
console.log(result);

配置选项

@jsonlee_12138/markdown-it-mermaid 提供以下配置选项：

• delay：用于防抖动的延迟时间（单位：毫秒）。默认为 30, 并且该值不能为 0, 否则会导致渲染不生效。

📝 贡献指南

欢迎提交issue或pull request，共同完善Markdown-It-Mermaid。

📄 许可证

MIT

联系我们

• Discord