# @diplodoc/mermaid-extension 中文文档
规范地址：https://npmcn.com/package/%40diplodoc/mermaid-extension/
版本：2\.2\.3
npm 元数据更新时间：2026-08-20T13:38:56.881Z
中文译文更新时间：2026-11-12T10:42:10.651Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40diplodoc/mermaid-extension
原文对照：https://npmcn.com/package/%40diplodoc/mermaid-extension/?lang=original
项目主页：https://github.com/diplodoc-platform/mermaid-extension#readme
源码仓库：https://github.com/diplodoc-platform/mermaid-extension
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：30.6 MB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：5 个
- peer 依赖：markdown-it ^13\.0\.0，react ^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2023-04-17T18:11:24.236Z
- 最新版本发布：2026-08-20T13:38:56.509Z
- 近 30 天下载量：21050（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 11 个）
## 中文简介
Diplodoc 变压器和构建器的美人鱼插件
## 安装
```sh
npm install @diplodoc/mermaid-extension
```
也可以使用：`pnpm add @diplodoc/mermaid-extension`、`yarn add @diplodoc/mermaid-extension`、`bun add @diplodoc/mermaid-extension`
## README
**英语** | [русский](https://github.com/diplodoc-platform/mermaid-extension/blob/master/README.ru.md)
* * *
[](https://www.npmjs.org/package/@diplodoc/mermaid-extension) [](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_mermaid-extension) [](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_mermaid-extension) [](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_mermaid-extension) [](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_mermaid-extension) [](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_mermaid-extension)
# Diplodoc 美人鱼扩展
这是Diplodoc平台的扩展,它增加了对美人鱼图的支持.
扩展部分包括:
- [准备美人鱼运行时间](https://npmcn.com/package/%40diplodoc/mermaid-extension/#readme-prepared-mermaid-runtime)
- [它变换插件](https://npmcn.com/package/%40diplodoc/mermaid-extension/#readme-markdownit-transform-plugin)
- [对美人鱼进行智能控制的反应钩和组件](https://npmcn.com/package/%40diplodoc/mermaid-extension/#readme-react-hook-and-component-for-smart-control-of-mermaid)
## 快速启动
在变压器上附加插件
```js
import mermaid from '@diplodoc/mermaid-extension';
import transform from '@diplodoc/transform';
const {result} = await transform(
`
\`\`\`mermaid
graph TD
A[Christmas] -->|Get money| B(Go shopping)
\`\`\`
`,
{
plugins: [mermaid.transform({bundle: false})],
},
);
```
将美人鱼运行时间添加到您的最后一页
```html
${result.html}
```
## 准备美人鱼运行时间
美人鱼的问题在于它大小很大. 最预期的行为是同步装入. 但是如果我们想让美人鱼停用 `startOnLoad` 我们不知道美人鱼什么时候才能被初始化.
**准备美人鱼运行时间** 旨在解决这个问题. 我们禁用美人鱼 `startOnLoad` 选择精确控制使步骤. 然后我们添加 `mermaidJsonp` 全球回调处理美人鱼装入.
此外,我们通过两种方法限制暴露的美人鱼API:
- `initialize` - 在下次渲染前配置美人鱼
- `run` - 开始图表渲染
用法示例:
```js
window.mermaidJsonp = window.mermaidJsonp || [];
// This callback will be called when runtime is loaded
window.mermaidJsonp.push((mermaid) => {
mermaid.initialize({theme: 'dark'});
mermaid.run();
});
// You can configure more than one callback
window.mermaidJsonp.push((mermaid) => {
console.log('Render diagrams');
});
```
### 自定义初始化选项
已曝光 `mermaid.initialize` 方法有额外的配置选项 :
- `zoom` - 启用图表 _缩放和探索_ 特性。 可以是布尔或带有内道具的物体.
(错误:虚假)
- `showMenu` - 显示导航菜单.
(错误:虚假)
- `bindKeys` - 启用 `wasd` 控制系统.
使用 `w/a/s/d` 探索图, `e/q` 缩放 `r` 以重置图表位置.
(错误:虚假)
- `maximumScale` - 最大缩放范围.
(过失:5)
- `resetOnBlur` - 重置外键上的图表位置.
(错误:虚假)
## 它变换插件
插件用于 [@ diplodoc/ 变形](https://github.com/diplodoc-platform/transform) 软件包.
配置 :
- `runtime` - 显示结果的运行时脚本名称 `script` 节.
(默认 : `_assets/mermaid-extension.js`(中文(简体) )
- `bundle` - 布尔旗以启用/无法复制捆绑的运行时间到目标目录.
目标目录所在 `/`
默认: 真
- `classes` - 在美人鱼图上增加一些课.
示例 `my-own-class and-other-class`
## 对美人鱼进行智能控制的反应钩和组件
用反应来简化美人鱼控制
```tsx
import React from 'react';
import {transform} from '@diplodoc/transform';
import mermaid from '@diplodoc/mermaid-extension/plugin';
import {MermaidRuntime} from '@diplodoc/mermaid-extension/react';
const MERMAID_RUNTIME = 'extension:mermaid';
const Doc: React.FC = ({content}) => {
const result = transform(content, {
plugins: [
// Initialize plugin for client/server rendering
mermaid.transform({
// Do not touch file system
bundle: false,
// Set custom runtime name for searching in result scripts
runtime: MERMAID_RUNTIME,
}),
],
});
// Load mermaid only if one or more diagram should be rendered
if (result.script.includes(MERMAID_RUNTIME)) {
// Load oversized mermaid runtime asynchronously
import('@diplodoc/mermaid-extension/runtime');
}
return ;
};
export const App: React.FC = ({theme}) => {
return (
<>
|Get money| B(Go shopping)
B --> C{Let me think}
\`\`\`
`}
/>
);
};
```
关于建筑、发展和贡献的详情,见 [一般事务人员(其他职等)](https://npmcn.com/package/%40diplodoc/mermaid-extension/AGENTS.md)。 。 。 .
## 常见问题
### @diplodoc/mermaid-extension 是什么？
Diplodoc 变压器和构建器的美人鱼插件
### 如何安装 @diplodoc/mermaid-extension？
在项目目录运行 npm install @diplodoc/mermaid-extension，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：markdown-it（^13\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @diplodoc/mermaid-extension 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @diplodoc/mermaid-extension 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。
### @diplodoc/mermaid-extension 需要什么版本的 Node\.js？
package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
### @diplodoc/mermaid-extension 可以商用吗？
@diplodoc/mermaid-extension 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @diplodoc/mermaid-extension 的下载量有多少？
根据 npm 官方下载统计，@diplodoc/mermaid-extension 在 2026/10/13 – 2026/11/11 这 30 天内被下载 21,050 次，日均约 702 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @diplodoc/mermaid-extension 还在维护吗？
最新版本 2\.2\.3 发布于 2026/08/20（2 个月前）；至今共发布 37 个版本，其中过去 12 个月发布了 11 个；首次发布于 2023/04/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。