# @adobe/jsonschema2md 中文文档

规范地址：https://npmcn.com/package/%40adobe/jsonschema2md/

版本：8\.0\.11
npm 元数据更新时间：2026-10-01T01:33:44.769Z
中文译文更新时间：2026-11-05T18:35:35.235Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：215 kB，40 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^18\.0\.0 \|\| \>= 20\.0\.0
- 运行依赖：18 个
- 首次发布：2017-12-06T10:50:10.850Z
- 最新版本发布：2026-03-23T19:36:40.266Z
- 近 30 天下载量：65438（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：208（近 12 个月 4 个）

## 中文简介

以简单的方式验证和记录复杂的JSON Schemas.

## 安装

```sh
npm install @adobe/jsonschema2md
```

也可以使用：`pnpm add @adobe/jsonschema2md`、`yarn add @adobe/jsonschema2md`、`bun add @adobe/jsonschema2md`

## README

# JSON Schema 马克当工具

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/adobe/jsonschema2md/main.yaml)](https://github.com/adobe/jsonschema2md/actions/workflows/main.yaml)

记录和验证复杂的JSON Schemas可能很困难. 这个工具通过提供一些能将JSON Schema文件变成可读的Markdown文档的脚本来方便它,这些可读的Markdown文档已经准备好在GitHub上消费或使用Jekyll或其他静态站点生成器处理.

这些工具被Adobe引入来记录Adobe的经验数据模型(XDM),但也可以用于其他JSON Schema文档.

## JSON 舍马支持

`jsonschema2md` 这是针对JSON Schema开发的 `2019-09`,但不支持完整的词汇。 请检查一下 [由 JSON Schema 支持的详细关键词列表 `jsonschema2md`](https://npmcn.com/package/%40adobe/jsonschema2md/schemasupport.md). 这份名单通过我们的测试更新.

## 所需资源

-   `npm` 3.10.8或以上版本
-   `node` v18 或 v20 或上层

## 示例输出

用计谋 [`examples/schemas`](https://npmcn.com/package/%40adobe/jsonschema2md/examples/schemas) (注: `*.schema.json` 扩展名,输出于 [`examples/docs`](https://npmcn.com/package/%40adobe/jsonschema2md/examples/docs) 已经生成.

## 安装和运行

```bash
$ npm install -g @adobe/jsonschema2md

# show usage information
$ jsonschema2md

# run task
$ jsonschema2md -d examples/schemas -o examples/docs
# generated output for whole folder is written to ./examples/docs
```

默认, `jsonschema2md` 查找结束于 `*.schema.json`中的扩展名 `--schema-extension` 或者说 `-e` 命令行参数.

## 国际化

生成的文件可以国际化. 使用 `-l` 参数.

支持的语言有:

-   联合国
-   德语

如果你想提供自己的翻译, [请使用 Git 本地化](https://gitlocalize.com/repo/3622)

## 在属性描述中显示自定义属性

`jsonschema2md` 仅显示由 JSON Schema 标准定义的属性。 如果您要在属性描述中显示附加属性, 您可以提供这些属性 `--properties` (或 `-p`) 参数.

```bash
# include both the `version` and the `test` attribute
$ jsonschema2md -d examples/schemas -o examples/docs -p version -p test
```

## 禁用页眉模板

在某些情况下,您不需要信头,因为它没有提供任何有用的信息。 与 `--header` (或 `-h`)参数可以禁用信头的包含.

```bash
# run against JSON Schema Draft 06
$ jsonschema2md -d examples/schemas -o examples/docs -v 06 -h false
```

## YAML 实例

如果您正在使用 JSON Schema 验证 YAML 文档, 例如配置文件, 您可能希望将示例格式化为 YAML, 而不是 JSON 。 使用命令行选项 `-f yaml` 或者说 `--example-format yaml` 实现这一目标.

## 使用 JSON Schema 马克当 工具来自 `npm`

您可以方便地使用 JSON Schema Markdown 工具 `npm`。这使得为您的 JSON Schema 项目设置转换工具链成为可能,该工具链完全由 `npm`要做到这一点,首先要通过在您 `"devDependencies"` 节 `package.json`

```json
  "devDependencies": {
    "@adobe/jsonschema2md": "^6.0.0"
  }
```

### 有脚本

然后在下面添加一个 `"scripts"` 区域 `package.json` 并相应调整:

```json
"scripts": {
  "prepare": "mkdir -p docs/reference && jsonschema2md -o docs/reference -d schemas/draft-04"
}
```

如果你运行 `npm install` 运行前 `npm run prepare`, (中文(简体) ), `npm` 将安装 `@adobe/jsonschema2md` 在一个 `node_modules/.bin` 路径,即使你没有事先安装 JSON Schema Markdown .

### 节点的API.js

```javascript
const {jsonschema2md} = require('@adobe/jsonschema2md');
const schema = require('examples/schemas/example.schema.json');

const markdown = jsonschema2md(schema, {
  includeReadme: true,
});
```

## 测试

确保您通过 `npm install`,然后运行 :

```bash
npm test
```

这将运行我们的茉莉花测试套件,以及根据我们的风格指南(见下文)将JavaScript涂入.

### 中情局

持续整合在Github Actions上进行. 所有拉动请求都会自动触发运行该程序的工作 [测试](https://npmcn.com/package/%40adobe/jsonschema2md/#readme-tests) 通过执行 [`main.yml`](https://npmcn.com/package/%40adobe/jsonschema2md/.github/workflows/main.yaml)。 。 。 .

### 代码覆盖

`npm run test` 将在测试运行结束时生成代码覆盖报告。 任何低于100%的覆盖率都是测试失败.

## 样式指南 / 林廷

这个项目使用 [埃斯林特语name](https://eslint.org/) 以强制实施 JavaScript 编码样式。 运行电线:

```bash
npm run lint
```

## 切换方式

添加对支持 [缺少关键字](https://npmcn.com/package/%40adobe/jsonschema2md/schemasupport.md)

## 捐款

请看 [捐款](https://npmcn.com/package/%40adobe/jsonschema2md/Contributing.md) 详细情况。 欢迎拉动请求.

## 许可证/版权

版权2017 Adobe系统公司. 版权所有. 此文件根据Apache许可证2.0版本("License")获得许可; 您不得使用此文件,除非符合许可证。 你可以拿到一份副本 许可证发放情况 [http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )](http://www.apache.org/licenses/LICENSE-2.0)

## 常见问题

### @adobe/jsonschema2md 是什么？

以简单的方式验证和记录复杂的JSON Schemas\.

### 如何安装 @adobe/jsonschema2md？

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

### @adobe/jsonschema2md 支持 TypeScript 吗？

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

### @adobe/jsonschema2md 支持 ESM 还是 CommonJS？

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

### @adobe/jsonschema2md 需要什么版本的 Node\.js？

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

### @adobe/jsonschema2md 可以商用吗？

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

### @adobe/jsonschema2md 的下载量有多少？

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

### @adobe/jsonschema2md 还在维护吗？

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