# @accordproject/markdown-transform 中文文档

规范地址：https://npmcn.com/package/%40accordproject/markdown-transform/

版本：2\.0\.0
npm 元数据更新时间：2026-10-11T11:05:16.508Z
中文译文更新时间：2026-11-06T03:25:29.362Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：119 kB，43 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：6 个
- peer 依赖：@accordproject/concerto-core ^5\.0\.0
- 首次发布：2019-08-01T16:09:35.983Z
- 最新版本发布：2026-10-11T11:05:16.030Z
- 近 30 天下载量：5638（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：767（近 12 个月 6 个）

## 中文简介

用于转换下调数据的 API

## 安装

```sh
npm install @accordproject/markdown-transform
```

也可以使用：`pnpm add @accordproject/markdown-transform`、`yarn add @accordproject/markdown-transform`、`bun add @accordproject/markdown-transform`

## README

# 标记下变换 API

高级API在由此单列所支持的各种格式(CommonMark, CiceroMark, TemplateMark, HTML, Plaintext, CiceroEdit等)之间转换标记下的内容.

## 安装

```
npm install @accordproject/markdown-transform
```

此软件包取决于 `markdown-common`, (中文(简体) ), `markdown-cicero`, (中文(简体) ), `markdown-template` 财务报告和审定财务报表 `markdown-html`,自动拉入.

## 基本用途

```ts
import { transform } from '@accordproject/markdown-transform';

// markdown → HTML
const html = await transform(markdown, 'markdown', ['html']);
```

第三个参数是一系列目的格式。 当给予不止一个时,变相会被连锁地穿过每一个.

```ts
// markdown → ciceromark (unquoted variables) → HTML
const html = await transform(markdown, 'markdown', ['ciceromark_unquoted', 'html']);
```

在共同JS中:

```js
const { transform } = require('@accordproject/markdown-transform');
```

## 支持的格式

`markdown`, (中文(简体) ), `markdown_cicero`, (中文(简体) ), `markdown_template`, (中文(简体) ), `commonmark_tokens`, (中文(简体) ), `ciceromark_tokens`, (中文(简体) ), `templatemark_tokens`, (中文(简体) ), `commonmark`, (中文(简体) ), `ciceromark`, (中文(简体) ), `ciceromark_parsed`, (中文(简体) ), `ciceromark_unquoted`, (中文(简体) ), `templatemark`, (中文(简体) ), `ciceroedit`, (中文(简体) ), `html`, (中文(简体) ), `plaintext`。 。 。 .

使用 `formatDescriptor(name)` 检查格式 `fileFormat` (单位:千美元)`utf8` 编号 : `json` 编号 : `binary`及其外缘,或 `new TransformEngine(builtinTransformationGraph)` 来注册自己的格式/转换.

## 变形图

您可以为所支持的转换生成 PlantUML 状态图 :

```ts
import { generateTransformationDiagram } from '@accordproject/markdown-transform';
const plantUml = generateTransformationDiagram();
```

![Transforms](https://npmcn.com/package/%40accordproject/markdown-transform/transformations.png)

## 许可证

Accord Project源代码文件在位于LICENSE文件的Apache许可证2.0版本(Apache-2.0)下提供. 项目文件文件根据创用CC-BY-4.0国际许可证提供 [http://creativecommons.org/licenses/by/ 4.0/ 页面存档备份,存于互联网档案馆](http://creativecommons.org/licenses/by/4.0/)。 。 。 .

## 常见问题

### @accordproject/markdown-transform 是什么？

用于转换下调数据的 API

### 如何安装 @accordproject/markdown-transform？

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

### @accordproject/markdown-transform 支持 TypeScript 吗？

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

### @accordproject/markdown-transform 支持 ESM 还是 CommonJS？

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

### @accordproject/markdown-transform 需要什么版本的 Node\.js？

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

### @accordproject/markdown-transform 可以商用吗？

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

### @accordproject/markdown-transform 的下载量有多少？

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

### @accordproject/markdown-transform 还在维护吗？

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