@beoe/rehype-mermaid

中文文档
0.4.2发布于 2025/02/28MITTypeScriptES Module近 30 天下载 1858

rehype mermaid plugin

原始使用文档

@beoe/rehype-mermaid

Rehype plugin to generate Mermaid diagrams in place of code fences. This:

```mermaid
flowchart LR
  start --> stop
```

will be converted to

<figure class="beoe mermaid">
  <svg>...</svg>
</figure>

which can look like this:

flowchart LR
  start --> stop

Usage

import rehypeMermaid from "@beoe/rehype-mermaid";

const html = await unified()
  .use(remarkParse)
  .use(remarkRehype)
  .use(rehypeMermaid)
  .use(rehypeStringify)
  .process(`markdown`);

Online documentation provides more details.

版本与发布记录

@beoe/rehype-mermaid 共发布 8 个版本,首次发布于 2024/05/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.4.2latest2025/02/281.7 年前
0.4.12025/02/281.7 年前
0.4.02025/02/281.7 年前
0.3.02024/12/051.9 年前
0.2.02024/11/301.9 年前
0.1.02024/11/301.9 年前

关于 @beoe/rehype-mermaid 的常见问题

@beoe/rehype-mermaid 是什么?

rehype mermaid plugin

如何安装 @beoe/rehype-mermaid?

在项目目录运行 npm install @beoe/rehype-mermaid,或使用 pnpm add / yarn add / bun add。

@beoe/rehype-mermaid 支持 TypeScript 吗?

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

@beoe/rehype-mermaid 支持 ESM 还是 CommonJS?

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

@beoe/rehype-mermaid 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@beoe/rehype-mermaid 可以商用吗?

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

@beoe/rehype-mermaid 的下载量有多少?

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

@beoe/rehype-mermaid 还在维护吗?

最新版本 0.4.2 发布于 2025/02/28(1.7 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/05/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。