# @docmd/plugin-okf 中文文档

规范地址：https://npmcn.com/package/%40docmd/plugin-okf/

版本：0\.9\.9
npm 元数据更新时间：2026-11-03T17:29:22.266Z
中文译文更新时间：2026-11-12T13:57:58.773Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40docmd/plugin-okf
原文对照：https://npmcn.com/package/%40docmd/plugin-okf/?lang=original
项目主页：https://docmd.io/
源码仓库：https://github.com/docmd-io/docmd

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

- 包体积（解压后）：86.4 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- 首次发布：2026-06-25T17:32:06.819Z
- 最新版本发布：2026-11-03T17:29:21.913Z
- 近 30 天下载量：55364（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

从您的 docmd 站点生成一个开放知识格式( OKF) 捆绑, 供 AI 代理 消费 .

## 安装

```sh
npm install @docmd/plugin-okf
```

也可以使用：`pnpm add @docmd/plugin-okf`、`yarn add @docmd/plugin-okf`、`bun add @docmd/plugin-okf`

## README

# @ docmd/ plugin- okf

生成一个 [打开知识格式](https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing) (OKF)在构建时间捆绑,所以你的文档可以被AI代理消耗——双子座,克洛德,GPT,Cursor,以及任何能说出供应商中立的OKF spec的工具.

OKF 代表组织知识,作为带有 YAML 前题并加有打入的表的下标文件目录(`okf.yaml`),交互式图表查看器,以及机器可读的捆绑摘要. 捆绑坐在你的网站旁边(例如. `site/okf/`)所以可以直接指向代理人.

```js
// docmd.config.json

{
  "plugins": {
    "okf": {
      // config options, okf is enabled by default
    }
  }
}
```

部分 **[医生](https://github.com/docmd-io/docmd)** 文档引擎.

## 产出结构

```
site/okf/                          # Always emitted
├── okf.yaml                       # Typed manifest (bundle summary)
├── index.md                       # Karpathy-style catalog grouped by type
├── concepts/
│   └── <slug>.md                 # One markdown file per page
└── _meta/
    ├── bundle.json                # JSON mirror of okf.yaml
    └── lint-report.txt            # Warnings produced during generation

# Emitted only when `plugins.okf.graph: true`
├── graph/                         # Interactive viewer (open /okf/graph/)
│   ├── index.html                 # Force-directed graph viewer
│   ├── graph.json                 # Graph data (nodes + edges)
│   ├── graph.js                   # Viewer runtime (vanilla, no CDN deps)
│   └── graph.css                  # Viewer styles (theme-aware)
```

每个概念文件都带有 OKF 要求 `type` 字段在前题加上正版的平面标记,所以一个代理既可以导航清单,也可以阅读完整页.

## 选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `outputDir` | `string` | `'okf'` | Bundle 目录,相对于站点输出. |
| `bundleName` | `string` | 斜体 `config.title` | 内部使用的名称 `okf.yaml` 和图查看器标题. |
| `defaultType` | `string` | `'concept'` | 类型指定为没有明确类型的页面 . |
| `typeField` | `string` | `'type'` | OKF类型的前题字段名. |
| `warnOnMissingType` | `boolean` | `true` | 发送一个 TUI 警告,用于返回到 `defaultType`。 。 。 . |
| `includeFullMarkdown` | `boolean` | `true` | 复制原始 `.md` 每个概念文件的正文. |
| `graph` | `boolean` | `false` | 释放一个 `graph/` 包含 `index.html` + 键 `graph.js` + 键 `graph.css` + 键 `graph.json`. Opt-in自0.8.8起——OKF spec不需要取景器,而运出额外文件默认会给干净的捆绑增加噪音. 观众可以到达 `/okf/graph/` 没有自定义文件名,并获取 `graph.json` 从运行时的同一目录中, 所以 `file://` 还行. |
| `localeStrategy` | `'default-only' | 'folders' | 'mixed' | 'latest-only'` | `'default-only'` | 默认的单- locale( 捆绑只包含默认地块中的页面) 。 设定为 `'folders'` 当 i18n 启用时, 以 locale id 为单位嵌入概念,或 `'mixed'` 编号 : `'latest-only'` 其他战略. |
| `versionStrategy` | `'folders' | 'mixed' | 'latest-only'` | `'latest-only'` | 启用版本时, 以版本 id 为单位的巢穴概念 . |
| `excludePatterns` | `string[]` | `[]` | 在顶部跳过的额外光彩图案 `frontmatter.noindex` 编号 : `frontmatter.okf === false`。 。 。 . |

### 每页选择退出

页面可以选择两种方式退出 OKF 捆绑:

```markdown
---
noindex: true   # also excludes from sitemap, llms.txt, etc.
---

---
okf: false       # only excludes from the OKF bundle
---
```

### 类型分辨率优先

每页插件选择一个具有此优先级的类型 :

1.  `frontmatter.okf.type` (已注销)
2.  `frontmatter.type` (顶级)
3.  `frontmatter.okfType` (遗产)
4.  路径前缀推论( 如. `/guides/foo` → `guide`(中文(简体) )
5.  `defaultType` (如果 `warnOnMissingType`(中文(简体) )

路径前缀地图覆盖 `guides/`, (中文(简体) ), `api/`, (中文(简体) ), `reference/`, (中文(简体) ), `concepts/`, (中文(简体) ), `runbooks/`, (中文(简体) ), `datasets/`, (中文(简体) ), `metrics/`,以及 `tables/`。 。 。 .

## 文档

见 **[文件.doc.docmd.io](https://docs.docmd.io/)** 用于充分使用和API参考.

## 许可证

麻省理工学院

## 常见问题

### @docmd/plugin-okf 是什么？

从您的 docmd 站点生成一个开放知识格式\( OKF\) 捆绑, 供 AI 代理 消费 \.

### 如何安装 @docmd/plugin-okf？

在项目目录运行 npm install @docmd/plugin-okf，或使用 pnpm add / yarn add / bun add。

### @docmd/plugin-okf 支持 TypeScript 吗？

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

### @docmd/plugin-okf 支持 ESM 还是 CommonJS？

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

### @docmd/plugin-okf 需要什么版本的 Node\.js？

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

### @docmd/plugin-okf 可以商用吗？

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

### @docmd/plugin-okf 的下载量有多少？

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

### @docmd/plugin-okf 还在维护吗？

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