# @akebifiky/remark-simple-plantuml 中文文档

规范地址：https://npmcn.com/package/%40akebifiky/remark-simple-plantuml/

版本：1\.0\.2
npm 元数据更新时间：2022-04-04T12:29:04.239Z
中文译文更新时间：2026-11-05T22:15:19.301Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：9.3 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2020-02-18T06:20:53.521Z
- 最新版本发布：2020-12-14T16:29:25.670Z
- 近 30 天下载量：13517（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

`remark-simple-plantuml` 是一个简单的插件 [评论j](https://github.com/remarkjs/remark) 将用 Markdown 写的 PlantUML 代码转换为 `img` 标签.

## 安装

```sh
npm install @akebifiky/remark-simple-plantuml
```

也可以使用：`pnpm add @akebifiky/remark-simple-plantuml`、`yarn add @akebifiky/remark-simple-plantuml`、`bun add @akebifiky/remark-simple-plantuml`

## README

# 标记简单的 PlantUML 插件

[![Build Status](https://travis-ci.org/akebifiky/remark-simple-plantuml.svg?branch=master)](https://travis-ci.org/akebifiky/remark-simple-plantuml) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://npmcn.com/package/%40akebifiky/remark-simple-plantuml/LICENSE)

`remark-simple-plantuml` 是一个简单的插件 [评论j](https://github.com/remarkjs/remark) 将 PlantUML 代码块转换成图像节点.

## 安装

```bash
npm install --save @akebifiky/remark-simple-plantuml
```

## 示例

您可以使用此插件, 如以下

### 标记

````markdown
# Your markdown including PlantUML code block

```plantuml Your title
class SimplePlantUMLPlugin {
    + transform(syntaxTree: AST): AST
}
```
````

### Java 脚本

```javascript
const remark = require("remark");
const simplePlantUML = require("@akebifiky/remark-simple-plantuml");
const fs = require("fs");
const path = require("path");

const input = fs.readFileSync(path.resolve(__dirname, "./your-markdown.md")).toString();
const output = remark().use(simplePlantUML).processSync(input).toString();

console.log(output);
// will be 
// > # Your markdown including PlantUML code block
// >
// > ![Your title](https://www.plantuml.com/plantuml/png/Iyv9B2vM2CxCBSX93SX9p2i9zVK9o2bDpynJgEPI009jXPAYnBpYjFoYN8tYohoIn8gGejHKAmN7u11DCCbL2m00)
```

## 插件选项

您可以通过“ baseUrl” 选项使用特定的 PlantUML 服务器 . (默认为 `https://www.plantuml.com/plantuml/png`(中文(简体) )

如果您想要使用 SVG , 您可以像以下配置 .

```javascript
remark().use(simplePlantUML, { baseUrl: "https://www.plantuml.com/plantuml/svg" }).processSync(input);
```

## 一体化

您可以在任何框架中使用此插件支持注释js .

如果你想在经典预设中使用 [Docusaurus 2 定义](https://v2.docusaurus.io/)和我一样,在您的配置 `docusaurus.config.js` 喜欢跟随.

```javascript
const simplePlantUML = require("@akebifiky/remark-simple-plantuml");

// your configurations...

presets: [
    [
      "@docusaurus/preset-classic",
      {
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          remarkPlugins: [simplePlantUML]
        }
      }
    ]
  ],

//...
```

## 常见问题

### @akebifiky/remark-simple-plantuml 是什么？

remark-simple-plantuml 是一个简单的插件 评论j 将用 Markdown 写的 PlantUML 代码转换为 img 标签\.

### 如何安装 @akebifiky/remark-simple-plantuml？

在项目目录运行 npm install @akebifiky/remark-simple-plantuml，或使用 pnpm add / yarn add / bun add。

### @akebifiky/remark-simple-plantuml 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/akebifiky\_\_remark-simple-plantuml 是否存在。

### @akebifiky/remark-simple-plantuml 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @akebifiky/remark-simple-plantuml 可以商用吗？

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

### @akebifiky/remark-simple-plantuml 的下载量有多少？

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

### @akebifiky/remark-simple-plantuml 还在维护吗？

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