# @bytemd/plugin-mermaid 中文文档

规范地址：https://npmcn.com/package/%40bytemd/plugin-mermaid/

版本：1\.22\.0
npm 元数据更新时间：2025-02-12T07:00:12.013Z
中文译文更新时间：2026-11-08T21:57:28.720Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bytemd/plugin-mermaid
原文对照：https://npmcn.com/package/%40bytemd/plugin-mermaid/?lang=original
项目主页：https://github.com/bytedance/bytemd#readme
源码仓库：https://github.com/bytedance/bytemd

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.6 MB，57 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：bytemd ^1\.5\.0
- 首次发布：2020-04-07T11:57:35.383Z
- 最新版本发布：2025-02-12T07:00:11.796Z
- 近 30 天下载量：2892（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 0 个）

## 中文简介

支持美人鱼图的字节MD插件

## 安装

```sh
npm install @bytemd/plugin-mermaid
```

也可以使用：`pnpm add @bytemd/plugin-mermaid`、`yarn add @bytemd/plugin-mermaid`、`bun add @bytemd/plugin-mermaid`

## README

# @bytemd/plugin-美人鱼

[![npm](https://img.shields.io/npm/v/@bytemd/plugin-mermaid.svg)](https://npm.im/@bytemd/plugin-mermaid)

支持美人鱼图的字节MD插件

## 使用量

```js
import mermaid from '@bytemd/plugin-mermaid'
import { Editor } from 'bytemd'

new Editor({
  target: document.body,
  props: {
    plugins: [
      mermaid(),
      // ... other plugins
    ],
  },
})
```

## 许可证

麻省理工学院

## 常见问题

### @bytemd/plugin-mermaid 是什么？

支持美人鱼图的字节MD插件

### 如何安装 @bytemd/plugin-mermaid？

在项目目录运行 npm install @bytemd/plugin-mermaid，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：bytemd（^1\.5\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bytemd/plugin-mermaid 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bytemd/plugin-mermaid 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bytemd/plugin-mermaid 可以商用吗？

@bytemd/plugin-mermaid 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bytemd/plugin-mermaid 的下载量有多少？

根据 npm 官方下载统计，@bytemd/plugin-mermaid 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,892 次，日均约 96 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bytemd/plugin-mermaid 还在维护吗？

最新版本 1\.22\.0 发布于 2025/02/12（1\.7 年前）；至今共发布 47 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/04/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。