# @file-viewer/capability-mermaid 中文文档

规范地址：https://npmcn.com/package/%40file-viewer/capability-mermaid/

版本：3\.3\.3
npm 元数据更新时间：2026-10-31T11:23:45.388Z
中文译文更新时间：2026-11-14T17:44:50.605Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40file-viewer/capability-mermaid
原文对照：https://npmcn.com/package/%40file-viewer/capability-mermaid/?lang=original
项目主页：https://doc.file-viewer.app/guide/on-demand-renderers
源码仓库：https://github.com/flyfish-dev/file-viewer

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

- 包体积（解压后）：8.2 MB，111 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-08-28T00:07:36.516Z
- 最新版本发布：2026-10-31T11:23:45.044Z
- 近 30 天下载量：7163（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

在文件查看器中为 Markdown 提供 Opt- in 美人鱼渲染 .

## 安装

```sh
npm install @file-viewer/capability-mermaid
```

也可以使用：`pnpm add @file-viewer/capability-mermaid`、`yarn add @file-viewer/capability-mermaid`、`bun add @file-viewer/capability-mermaid`

## README

# @file-viewer/capability-mermaid

[English](https://github.com/flyfish-dev/file-viewer/blob/main/packages/capabilities/mermaid/README.md) · [简体中文](https://github.com/flyfish-dev/file-viewer/blob/main/packages/capabilities/mermaid/README.zh-CN.md)

导入后为 Markdown 内嵌 Mermaid 代码块注册 Mermaid loader。standard 默认不安装。

当前源码通过正常构建，将 Mermaid 12.1.0 与 KaTeX 0.18.2 打入包内，并通过 `@file-viewer/capability-mermaid/engine` 为绘图渲染器提供相同引擎。应用安装当前候选无需配置依赖安全 overrides。`dist/bundled-runtime.json` 记录实际输入版本、锁文件和源码哈希、许可文本及输出文件哈希；完整第三方许可位于 `dist/THIRD_PARTY_LICENSES.txt`。

构建源码需要 Node.js 22.12 或更高版本，这是 Mermaid 12 的构建依赖要求。发布包提供编译后的浏览器引擎，应用不需要安装原始 Mermaid 包。

Node20 消费兼容性由独立的 Node20.20.2 安装与浏览器构建验证。设置 `FILE_VIEWER_CONSUMER_NODE` 和 `FILE_VIEWER_CONSUMER_NPM_CLI` 为该运行时的 Node 二进制和 npm CLI 路径后，以构建源码的 Node 运行 `node scripts/verify-packed-browser.mjs --node20-consumer`。Public CI 同时执行普通 Vite 消费检查和这一独立消费检查。

数学标签默认使用 KaTeX MathML，不请求外部字体或样式。带数学标签的图使用经过资源策略检查和 DOMPurify 清理的 `foreignObject`；普通图继续使用 SVG 标签。

`pnpm --filter @file-viewer/capability-mermaid verify:packed-browser` 在空缓存、无安全 overrides 的独立消费项目中核验打包文件与两种依赖审计，并在 Chromium、WebKit 中检查 Markdown 和绘图的实际图形、数学标签、带参与者配置的时序图与离线请求。3.2.2 构建使用上述内置运行时；较早的 npm 3.1.2 包仍保留其旧依赖图。

## 常见问题

### @file-viewer/capability-mermaid 是什么？

在文件查看器中为 Markdown 提供 Opt- in 美人鱼渲染 \.

### 如何安装 @file-viewer/capability-mermaid？

在项目目录运行 npm install @file-viewer/capability-mermaid，或使用 pnpm add / yarn add / bun add。

### @file-viewer/capability-mermaid 支持 TypeScript 吗？

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

### @file-viewer/capability-mermaid 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @file-viewer/capability-mermaid 可以商用吗？

@file-viewer/capability-mermaid 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @file-viewer/capability-mermaid 的下载量有多少？

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

### @file-viewer/capability-mermaid 还在维护吗？

最新版本 3\.3\.3 发布于 2026/10/31（14 天前）；至今共发布 13 个版本，其中过去 12 个月发布了 13 个；首次发布于 2026/08/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。