# @docmd/api 中文文档

规范地址：https://npmcn.com/package/%40docmd/api/

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

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

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

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

- 包体积（解压后）：184 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：3 个
- 首次发布：2026-04-18T07:36:37.000Z
- 最新版本发布：2026-11-03T17:27:43.107Z
- 近 30 天下载量：77848（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 38 个）

## 中文简介

Docmd 的插件 API 表面 .

## 安装

```sh
npm install @docmd/api
```

也可以使用：`pnpm add @docmd/api`、`yarn add @docmd/api`、`bun add @docmd/api`

## README

# @ docmd/ api (英语)

Docmd - hook 注册、 RPC 发送和源编辑工具的插件 API 表面 .

这个软件包是docmd插件系统的Canonic home. 它规定:

-   **插件加载器** - 验证、隔离和登记带有能力悬钩的插件
-   **动作调度器** - 用于现场编辑行动和火灾与遗忘事件的WebSocket RPC系统
-   **源工具** - 块级标记下源编辑(插入、替换、包装、去除)
-   **类型定义** - 说吧 `PluginDescriptor`, (中文(简体) ), `PluginModule`, (中文(简体) ), `ActionContext`, (中文(简体) ), `SourceTools`和更多

## 使用量

```typescript
import { loadPlugins, createActionDispatcher, createSourceTools } from '@docmd/api';
import type { PluginDescriptor, PluginModule } from '@docmd/api';
```

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

## 文档

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

## 许可证

麻省理工学院

## 常见问题

### @docmd/api 是什么？

Docmd 的插件 API 表面 \.

### 如何安装 @docmd/api？

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

### @docmd/api 支持 TypeScript 吗？

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

### @docmd/api 支持 ESM 还是 CommonJS？

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

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

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

### @docmd/api 可以商用吗？

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

### @docmd/api 的下载量有多少？

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

### @docmd/api 还在维护吗？

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