# @adobe/helix-md2jcr 中文文档

规范地址：https://npmcn.com/package/%40adobe/helix-md2jcr/

版本：1\.5\.19
npm 元数据更新时间：2026-10-27T20:53:56.289Z
中文译文更新时间：2026-11-06T16:00:10.657Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：369 kB，60 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：25 个
- 首次发布：2025-01-28T13:27:19.952Z
- 最新版本发布：2026-10-27T20:53:55.789Z
- 近 30 天下载量：2803（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：96（近 12 个月 37 个）

## 中文简介

将下标转换为 JCR 内容结构的螺旋服务

## 安装

```sh
npm install @adobe/helix-md2jcr
```

也可以使用：`pnpm add @adobe/helix-md2jcr`、`yarn add @adobe/helix-md2jcr`、`bun add @adobe/helix-md2jcr`

## README

# 螺旋马克下至 JCR

> 一个将马克下调转换为JCR的库.

## 状态

[![codecov](https://img.shields.io/codecov/c/github/adobe/helix-md2jcr.svg)](https://codecov.io/gh/adobe/helix-md2jcr) [![GitHub license](https://img.shields.io/github/license/adobe/helix-md2jcr.svg)](https://github.com/adobe/helix-md2jcr/blob/main/LICENSE.txt) [![GitHub issues](https://img.shields.io/github/issues/adobe/helix-md2jcr.svg)](https://github.com/adobe/helix-md2jcr/issues) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## 发展

通过运行安装所有依赖 :

```bash
npm install
```

## 使用量

### 安装

您可以通过 npm 安装软件包 :

```bash
npm install @adobe/helix-md2jcr
```

或直接使用它与 `npx` 不安装 :

```bash
npx @adobe/helix-md2jcr path/to/content.md
```

### 将 Markdown 转换为 JCR 节点

软件包包括一个 CLI 工具 `md2jcr` 将标记下的文件转换为 JCR XML 格式.

**基本用途:**

```bash
npx @adobe/helix-md2jcr path/to/content.md
```

**转换单个文件 :**

```bash
md2jcr test/fixtures/simple.md
```

**转换目录中所有标记下的文件 :**

```bash
md2jcr test/fixtures/
```

**用动词旗查看控制台中的输出 `-v`数字 :**

```bash
md2jcr test/fixtures/simple.md -v
```

**查看已解码的 XML 输出 `-v` 财务报告和审定财务报表 `-d` 旗帜 :**

```bash
md2jcr test/fixtures/simple.md -v -d
```

**使用目录中的自定义通用编辑器文件 :**

```bash
md2jcr content.md -ue path/to/ue-files-directory
```

转换器将生成一个 `.xml` 与包含 JCR 结构的标记下文件并列的文件。 这可用于检查由于转换而可能出现的内容变化.

#### 命令行选项

-   `-v`, (中文(简体) ), `--verbose` - 将 XML 输出打印到控制台
-   `-d`, (中文(简体) ), `--decode` - XML 输出中的解码 HTML 实体(使用 `-v`(中文(简体) )
-   `-ue`, (中文(简体) ), `--ue-files <directory>` - 指定包含通用编辑器配置文件的目录

示例目录结构 :

```
ue-files/
  ├── component-models.json
  ├── component-definition.json
  └── component-filters.json
```

### 程序用途

您也可以在节点代码中程序化地使用库:

```javascript
import { md2jcr } from '@adobe/helix-md2jcr';

const markdown = '# Hello World\n\nThis is a test.';
const options = {
  models: [...],
  definition: {...},
  filters: [...]
};

const xml = await md2jcr(markdown, options);
console.log(xml);
```

## 文档

-   [集装箱区块](https://npmcn.com/package/%40adobe/helix-md2jcr/docs/container-blocks.md) ——容器块映射母体的方式 属性和子项(一栏/多栏规则,省略父项) 行,以及出错的情况)。 另见 [集装箱区块试验装置](https://npmcn.com/package/%40adobe/helix-md2jcr/test/fixtures/blocks/core/container-block/README.md) 以工作情景为例.
-   [块选项( 分类)](https://npmcn.com/package/%40adobe/helix-md2jcr/docs/block-options.md) 区块选项类和 元素分组( e)`classes`, (中文(简体) ), `classes_*`: 如何将页眉选项路由到 字段的选项或布尔后缀.
-   [区域样式](https://npmcn.com/package/%40adobe/helix-md2jcr/docs/section-styles.md) - 一节的元素分组 `style` 组`style`, (中文(简体) ), `style_*`: 单节元数据如何 `style` 单元格将返回字段,镜像块选项.
-   [实地提示](https://npmcn.com/package/%40adobe/helix-md2jcr/docs/field-hinting.md) - 使用 `<!-- field: name -->` 跳过 在战地小组内.
-   [定义内容](https://npmcn.com/package/%40adobe/helix-md2jcr/docs/phrasing.md) — 支持的内置 HTML 标记(`sup`, (中文(简体) ), `sub`, (中文(简体) ), `u`, (中文(简体) ), `del`, (中文(简体) ), `strong`, (中文(简体) ), `em`以及他们如何活过减速 ~ JCR管道.

## 基线 XML 文件

运行./ Baseline-tests.sh脚本将在测试/固定下检测出任何md文件并执行转换2jcr节点脚本.  
脚本将在它定位的 md 文件旁边生成新的 xml 文件 。 对转换器进行修改时会有帮助 您想要查看这些变化是否对输出有任何影响。 通过使用 git diff,您可以看到 xml 文件的新变化 . 如果您对修改感到满意,您可以提交新的 xml 文件.

## 运行测试

只需执行以下命令即可运行测试 :

```bash
npm test
```

## 常见问题

### @adobe/helix-md2jcr 是什么？

将下标转换为 JCR 内容结构的螺旋服务

### 如何安装 @adobe/helix-md2jcr？

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

### @adobe/helix-md2jcr 支持 TypeScript 吗？

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

### @adobe/helix-md2jcr 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @adobe/helix-md2jcr 可以商用吗？

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

### @adobe/helix-md2jcr 的下载量有多少？

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

### @adobe/helix-md2jcr 还在维护吗？

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