# @agentshouse/mdmodel 中文文档

规范地址：https://npmcn.com/package/%40agentshouse/mdmodel/

版本：0\.1\.0-c03f6cf931ca0
npm 元数据更新时间：2026-11-07T07:52:44.614Z
中文译文更新时间：2026-11-06T16:33:33.967Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：671 kB，541 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.22\.1
- 运行依赖：12 个
- 首次发布：2026-09-06T17:06:22.376Z
- 最新版本发布：2026-11-07T07:52:44.443Z
- 近 30 天下载量：19698（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 104 个）

## 中文简介

MD 类型语言、 解析器、 验证器、 结构化更改应用程序、 Markdown 语法配置文件以及符合性定型

## 安装

```sh
npm install @agentshouse/mdmodel
```

也可以使用：`pnpm add @agentshouse/mdmodel`、`yarn add @agentshouse/mdmodel`、`bun add @agentshouse/mdmodel`

## README

# `@agentshouse/mdmodel`

已打入 Markdown 文档: 在 JSON Schema 中声明的 MD 类型, 文件在其中写入其值 马克下体,一个读取器,一个编剧和一个验证器,一个结构化修改文档的决定性应用,和一个查询语言 在 SQL 中对一个收藏或在一个文档的内存进行回答,加上符合 固定装置.

它在浏览器和节点运行,不进行网络呼叫,不读取 文件系统。 它运送了一个无害环境管理文物,即第24.22.1号节点,以及后来 装入通过 `import` 或者说 `require`。 。 。 .

## 安装

```sh
npm install @agentshouse/mdmodel
```

## 使用量

```ts
import { apply, parse, serialize, validate, verify } from '@agentshouse/mdmodel';

const checked = verify('task:\n  properties:\n    title: { type: string, title: Title }\n');
if (checked.verdict === 'accept') {
  const task = checked.model.types.task;
  validate({ 'one.md': '---\ntype: task\n---\n- **Title**: Ship\n' }, undefined, checked.model);
  const parsed = parse('---\ntype: task\n---\n- **Title**: Hello\n', 'one.md', task);
  if (parsed.ok) {
    const change = { kind: 'field', name: 'title', value: 'World', prior: 'Hello' } as const;
    const next = apply(parsed.document, [change], task);
    if (next.outcome === 'applied') serialize(next.document);
  }
}
```

## API 密码

| 导出 | 目的 |
| --- | --- |
| `verify` | 校验一个 MD 类型模型的图案文本 |
| `validate` | 验证文本库; 返回接受或一次拒绝 |
| `parse`, (中文(简体) ), `serialize` | 读取并写入一个文档 |
| `apply` | 立即应用字段、部分、序言、链接和引用更改 |
| `links`, (中文(简体) ), `target`, (中文(简体) ), `retarget` | 库存和重写链接目的地 |
| `escapePointer` | 将一个键写为 JSON 指针符号 |
| `project`, (中文(简体) ), `divide` | 嵌入投影输入及其分解为 Spans |
| `facts`, (中文(简体) ), `candidateOf` | 一个文件如一个更改所示, 匹配为一个查询候选人 |
| `planOf`, (中文(简体) ), `matches`, (中文(简体) ), `sql` | 检查查询, 在一个文档上回答, 或将其编译到 SQL |
| `VERSION` | MD 模式版本 |
| `MEMBER_FIELD`, (中文(简体) ), `SITE_FIELD`, (中文(简体) ), `SUBMITTED_FIELD` | 前题密钥的校验数为类型之外的已声明 |
| `MEDIA_TYPES`, (中文(简体) ), `servedMediaType` | 媒体类型 House 和 文件扩展列表 |

全文见 [`API.md`](https://npmcn.com/package/%40agentshouse/mdmodel/API.md)符合性及其 判决格式和规则编号如下: [`fixtures/README.md`](https://npmcn.com/package/%40agentshouse/mdmodel/fixtures/README.md)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @agentshouse/mdmodel 是什么？

MD 类型语言、 解析器、 验证器、 结构化更改应用程序、 Markdown 语法配置文件以及符合性定型

### 如何安装 @agentshouse/mdmodel？

在项目目录运行 npm install @agentshouse/mdmodel，或使用 pnpm add / yarn add / bun add。

### @agentshouse/mdmodel 支持 TypeScript 吗？

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

### @agentshouse/mdmodel 支持 ESM 还是 CommonJS？

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

### @agentshouse/mdmodel 需要什么版本的 Node\.js？

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

### @agentshouse/mdmodel 可以商用吗？

@agentshouse/mdmodel 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @agentshouse/mdmodel 的下载量有多少？

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

### @agentshouse/mdmodel 还在维护吗？

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