# @accordproject/markdown-it-template 中文文档

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

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

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

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

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

- 包体积（解压后）：134 kB，70 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2020-06-05T16:42:23.733Z
- 最新版本发布：2026-10-11T11:05:49.351Z
- 近 30 天下载量：7141（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：663（近 12 个月 6 个）

## 中文简介

插件, 用于引入模板块和内含的标记下- 它的标记下分解器

## 安装

```sh
npm install @accordproject/markdown-it-template
```

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

## README

# 模板马克的下图插件

A 类 [`markdown-it`](https://github.com/markdown-it/markdown-it) 添加支持模板马克语法的插件——块级模板定义(clauses, command/unordered list 模板)和内置模板构造(可变,条件,可选,带有,加入,公式).

插件会发出标记- 其符号; 见 [`@accordproject/markdown-template`](https://npmcn.com/package/%40accordproject/markdown-template) 更高级的变压器 把那些符号变成模板马克DOM.

## 安装

```
npm install @accordproject/markdown-it-template
```

## 使用量

```ts
import MarkdownIt from 'markdown-it';
import MarkdownItTemplate from '@accordproject/markdown-it-template';

const md = new MarkdownIt({ html: true }).use(MarkdownItTemplate);

const tokens = md.parse(
    'Hello {{name}}, {{#if hasGift}}enjoy{{else}}sorry{{/if}}!',
    {}
);
```

在共同JS中:

```js
const MarkdownIt = require('markdown-it');
const MarkdownItTemplate = require('@accordproject/markdown-it-template');

const md = new MarkdownIt({ html: true }).use(MarkdownItTemplate);
```

## 语法支持

区块构造(每一段单独):

| 打开 | 关闭 | 模板马克节点 |
| --- | --- | --- |
| `{{#clause NAME}}` | `{{/clause}}` | `ClauseDefinition` |
| `{{#ulist NAME}}` | `{{/ulist}}` | `ListBlockDefinition` (弹夹) |
| `{{#olist NAME}}` | `{{/olist}}` | `ListBlockDefinition` (订购) |

内置构造 :

| 语法 | 模板马克节点 |
| --- | --- |
| `{{name}}` 或者说 `{{name as "format"}}` | `VariableDefinition` 编号 : `FormattedVariableDefinition` |
| `{{this}}` 或者说 `{{this as "format"}}` | `VariableDefinition` 目前范围 |
| `{{%TS code%}}` | `FormulaDefinition` |
| `{{#if NAME}}…{{else}}…{{/if}}` | `ConditionalDefinition` |
| `{{#optional NAME}}…{{/optional}}` | `OptionalDefinition` |
| `{{#with NAME}}…{{/with}}` | `WithDefinition` |
| `{{#join NAME ...}}…{{/join}}` | `JoinDefinition` |

## 许可证

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

插件, 用于引入模板块和内含的标记下- 它的标记下分解器

### 如何安装 @accordproject/markdown-it-template？

在项目目录运行 npm install @accordproject/markdown-it-template，或使用 pnpm add / yarn add / bun add。

### @accordproject/markdown-it-template 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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

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

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