# @accordproject/markdown-cli 中文文档

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

版本：2\.0\.0
npm 元数据更新时间：2026-10-11T11:04:51.259Z
中文译文更新时间：2026-11-09T22:22:07.325Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：43.7 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- 首次发布：2019-09-12T06:19:56.107Z
- 最新版本发布：2026-10-11T11:04:50.948Z
- 近 30 天下载量：1706（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：1015（近 12 个月 11 个）

## 中文简介

改造减值的框架

## 安装

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

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

## README

# 命令行

安装 `@accordproject/markdown-cli` 获取 npm 软件包 `markus` 命令行界面(CLI). 安装后,您可以使用 `markus` 命令及其子命令如下.

要安装 :

```bash
npm install -g @accordproject/markdown-cli
```

## 使用量

`markus` 是一个命令行工具,用于调试并使用标记下变换.

```md
markus <cmd> [args]

Commands:
  markus transform  transform between two formats

Options:
  --version      Show version number                                   [boolean]
  --verbose, -v                                                 [default: false]
  --help         Show help                                             [boolean]
```

## `markus transform`

这个 `markus transform` 命令允许您在支持的任意两种格式之间转换.

```md
markus transform

transform between two formats

Options:
  --version      Show version number                                   [boolean]
  --verbose, -v  verbose output                       [boolean] [default: false]
  --help         Show help                                             [boolean]
  --input        path to the input                                      [string]
  --from         source format                    [string] [default: "markdown"]
  --to           target format                  [string] [default: "commonmark"]
  --via          intermediate formats                      [array] [default: []]
  --roundtrip    roundtrip transform                  [boolean] [default: false]
  --output       path to the output file                                [string]
  --model        array of concerto model files                           [array]
  --template     template grammar                                       [string]
  --contract     contract template                    [boolean] [default: false]
  --currentTime  set current time                       [string] [default: null]
  --plugin       path to a parser plugin                                [string]
  --extension    path to a transform extension                           [array]
  --sourcePos    enable source position               [boolean] [default: false]
  --offline      do not resolve external models       [boolean] [default: false]
```

支持的格式 `--from` 编号 : `--to` 编号 : `--via`数字 :

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

### 示例

运行 `transform` 标记下的文件 :

```bash
markus transform --input README.md
```

返回 :

```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": "Hello World"
        }
      ]
    },
    {
      "$class": "org.accordproject.commonmark@0.5.0.Paragraph",
      "nodes": [
        {
          "$class": "org.accordproject.commonmark@0.5.0.Text",
          "text": "This is the Hello World of Accord Project Templates. Executing the clause will simply echo back the text that occurs after the string "
        },
        {
          "$class": "org.accordproject.commonmark@0.5.0.Code",
          "text": "Hello"
        },
        {
          "$class": "org.accordproject.commonmark@0.5.0.Text",
          "text": " prepended to text that is passed in the request."
        }
      ]
    }
  ]
}
```

### `--from` 财务报告和审定财务报表 `--to` 选项

设置源和目标格式 。 以下将下标记转换为 HTML :

```bash
markus transform --from markdown --to html --input README.md
```

返回 :

```html
<html>
<body>
<div class="document">
<h1>Hello World</h1>
<p>This is the Hello World of Accord Project Templates. Executing the clause will simply echo back the text that occurs after the string <code>Hello</code> prepended to text that is passed in the request.</p>
</div>
</body>
</html>
```

### `--via` 选项

当两种格式之间有好几种路径时,您可以通过中间格式进行路由. 以下转型从 `markdown` 改为 `html` _通过_ `ciceromark`数字 :

```bash
markus transform --from markdown --via ciceromark --to html --input README.md
```

### `--roundtrip` 选项

您可以在两种格式之间绕行——从源到目标再转换回源. 譬如说, `markdown → ciceromark → markdown`数字 :

```bash
markus transform --from markdown --to ciceromark --input README.md --roundtrip
```

返回 :

```bash
Hello World
====

This is the Hello World of Accord Project Templates. Executing the clause will simply echo back the text that occurs after the string `Hello` prepended to text that is passed in the request.
```

圆通可能会在源码下标值上造成小的文字差异,但应当始终是等同的. 在以上示例中,ATX标题 `# Hello World` 已转换为相应的 Setext 标题.

### `--model` 财务报告和审定财务报表 `--contract` 选项

处理时 [模板马克](https://docs.accordproject.org/docs/markdown-templatemark),提供音乐会模式 `--model` 添加 `--contract` 如果模板是合同(否则则被视为一项条款).

例如,以下将模板马克文件转换到其DOM:

```bash
markus transform \
  --from markdown_template --to templatemark \
  --model model/model.cto \
  --input text/grammar.tem.md
```

返回 :

```json
{
  "$class": "org.accordproject.commonmark@0.5.0.Document",
  "xmlns": "http://commonmark.org/xml/1.0",
  "nodes": [
    {
      "$class": "org.accordproject.templatemark@0.5.0.ClauseDefinition",
      "name": "top",
      "elementType": "org.accordproject.helloworld.HelloWorldClause",
      "nodes": [
        {
          "$class": "org.accordproject.commonmark@0.5.0.Paragraph",
          "nodes": [
            {
              "$class": "org.accordproject.commonmark@0.5.0.Text",
              "text": "Name of the person to greet: "
            },
            {
              "$class": "org.accordproject.templatemark@0.5.0.VariableDefinition",
              "name": "name",
              "elementType": "String"
            },
            {
              "$class": "org.accordproject.commonmark@0.5.0.Text",
              "text": "."
            },
            {
              "$class": "org.accordproject.commonmark@0.5.0.Softbreak"
            },
            {
              "$class": "org.accordproject.commonmark@0.5.0.Text",
              "text": "Thank you!"
            }
          ]
        }
      ]
    }
  ]
}
```

### `--extension` 选项

过 `--extension path/to/ext.js` (可重复)在运行时注册自定义变换扩展. 扩展为导出模块 `{ format?, transforms? }` 地点 `format` 宣布新的格式 `transforms` 在变换图中宣布边缘为/从它开始。 例子参见此包中的集成测试.

## 许可证

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

改造减值的框架

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

在项目目录运行 npm install @accordproject/markdown-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 markus，可以用 npx markus 直接运行。

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

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

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

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

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

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

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

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

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

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

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

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