# @accordproject/markdown-common 中文文档

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

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

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

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

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

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

## 中文简介

改造减值的框架

## 安装

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

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

## README

# 普通马克变形器

将下标文本转换为/ 从 CommonMark DOM 中转换 .

CommunityMark DOM 是一个音乐会模式——参见 [`commonmark@0.5.0`](https://models.accordproject.org/markdown/commonmark@0.5.0.html)。 。 。 .

## 安装

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

同伴依赖 : `@accordproject/concerto-core@^5.0.0`。 。 。 .

## 使用量

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

const transformer = new CommonMarkTransformer();
const dom = transformer.fromMarkdown('# Heading\n\nThis is some `code`.\n\nFin.');
console.log(JSON.stringify(dom, null, 4));
```

通用JS同样工作:

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

产出是:

```json
{
    "$class": "org.accordproject.commonmark@0.5.0.Document",
    "xmlns": "http://commonmark.org/xml/1.0",
    "nodes": [
        {
            "$class": "org.accordproject.commonmark@0.5.0.Heading",
            "level": "1",
            "nodes": [
                {
                    "$class": "org.accordproject.commonmark@0.5.0.Text",
                    "text": "Heading"
                }
            ]
        },
        {
            "$class": "org.accordproject.commonmark@0.5.0.Paragraph",
            "nodes": [
                {
                    "$class": "org.accordproject.commonmark@0.5.0.Text",
                    "text": "This is some "
                },
                {
                    "$class": "org.accordproject.commonmark@0.5.0.Code",
                    "text": "code"
                },
                {
                    "$class": "org.accordproject.commonmark@0.5.0.Text",
                    "text": "."
                }
            ]
        },
        {
            "$class": "org.accordproject.commonmark@0.5.0.Paragraph",
            "nodes": [
                {
                    "$class": "org.accordproject.commonmark@0.5.0.Text",
                    "text": "Fin."
                }
            ]
        }
    ]
}
```

您可以操纵 DOM 并将其转换回下调 :

```ts
dom.nodes[0].nodes[0].text = 'My New Heading';
const newMarkdown = transformer.toMarkdown(dom);
console.log(newMarkdown);
```

新的标记下字符串将是:

```markdown
My New Heading
====

This is some `code`.

Fin.
```

> 注意 H1 标题在从 `#` 语法改为 `====` 语法. 在CommonMark中,这些是等同的.

## 此套件导出什么

-   `CommonMarkTransformer` - 减分 普通马克DOM
-   `ToMarkdownVisitor`, (中文(简体) ), `FromCommonMarkVisitor`, (中文(简体) ), `FromMarkdownIt` ——下层构件
-   `CommonMarkUtils` – 用于渲染标记下调的助手( 取消缩写, 列表前缀等)
-   `Stack` 参观者使用的通用堆栈
-   `CommonMarkModel`, (中文(简体) ), `CiceroMarkModel`, (中文(简体) ), `ConcertoMetaModel`, (中文(简体) ), `TemplateMarkModel` – 音乐会命名空间/ MODEL 字符串被此单曲中其他软件包所消耗

## 许可证

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-common 是什么？

改造减值的框架

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

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

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

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

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

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

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

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

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

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

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

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

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

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