Communitygithub.com

docmd 框架开发技能

一套模块化技能,帮助AI智能体理解和处理 docmd 文档项目的框架开发工作。

docmd 框架开发技能 是什么?

此技能专为 AI 智能体设计,用于在 docmd 单体仓库内进行框架层面的开发工作,例如编写插件、模板、修改核心或引擎。它能自动检测用户是否在 docmd 项目目录内工作,并指导智能体完成克隆仓库、安装依赖、以及引用相关的开发文档(如 API 开发参考、插件开发指南等)。支持平台包括 Claude Code、Cursor、Codex 等兼容 AI 技能加载机制的开发工具。通过此技能,开发者可以高效地参与 docmd 框架的扩展与定制,而不需要手动查找文档或执行繁琐的仓库配置步骤。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add docmd-io/docmd-skills

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

docmd — 代理技能(开发者)

当用户想要修改 docmd 框架本身,而不是消费它的站点时使用此技能。此技能由 npx docmd-skills dev <dir> 加载,并且会在现有的 docmd-skills/ 安装旁添加 docmd-dev/。

何时使用此技能

当任意一个信号为真时使用:

  1. 用户当前工作目录是 docmd 单体仓库的克隆。本地克隆目录命名为 docmd/(GitHub 路径为 docmd-io/docmd/)。标志性文件:pnpm-lock.yaml、packages/core/src/、packages/ui/src/、packages/api/src/、packages/plugins/<name>/、packages/engines/。克隆方法:git clone https://github.com/docmd-io/docmd.git docmd && cd docmd。
  2. 用户明确表示想要“编写插件”、“编写模板”、“扩展引擎”、“修改核心”、“添加钩子”或类似内容。
  3. 用户在 docmd 单体仓库的 packages/core/src/、packages/api/src/、packages/ui/src/、packages/plugins/*/src/ 或 packages/engines/*/ 内编辑文件。

如果用户需要框架帮助但工作目录中没有 docmd/ 克隆,在操作前先询问:是否希望克隆单体仓库(git clone https://github.com/docmd-io/docmd.git docmd)或刷新现有克隆(git -C docmd pull)?不要在未更新本地克隆的情况下开始编辑框架源码。

不要将其用于:站点级配置或操作(使用 docmd-skills),或页面散文质量(使用 docmd-writer)。

加载规则

  • 仅当用户正在 docmd 单体仓库中积极工作或明确询问框架内部时加载此技能。
  • 如有疑问,默认使用 docmd-skills(用户)。切换到此技能意味着用户已准备好对单体仓库运行 pnpm 命令。

参考索引

每行对应一个参考文件。CLI 列显示哪个安装子命令添加此文件。

参考文件CLI 安装子命令用途
references/api-dev.mddocmd-skills dev框架作者的公共 Node API:EngineLoader、URL utilities、createActionDispatcher、TemplateSlot、钩子/动作合约
references/plugin-development.mddocmd-skills dev编写 docmd 插件:包结构、manifest、apply() 生命周期、template 能力、钩子、测试
references/template-development.mddocmd-skills dev编写 docmd 主题/模板:12 个模板插槽、资源管道、manifest.json、模板插件
references/engines.mddocmd-skills devJS 与 Rust 构建引擎、引擎切换、引擎特定配置、性能权衡

工作流

1. 克隆或刷新单体仓库

尚无克隆 — 克隆并安装:

git clone https://github.com/docmd-io/docmd.git docmd
cd docmd
pnpm install

已有克隆 — 刷新并重新安装依赖(如有必要):

git -C docmd pull
pnpm install

如需在决定前检查克隆是否落后,运行 git -C docmd status(查找“Your branch is behind”)或 git -C docmd log -1 --oneline 并与 https://github.com/docmd-io/docmd/commits/main 比较。

本地克隆目录是 docmd/(不是 docmd-io/docmd/)。在其内部,您将找到本技能中引用的规范包布局。

2. 编写插件

  1. 在搭建前通读 references/plugin-development.md。
  2. 选择 packages/plugins/<name>/ 下最接近的现有插件并复制其结构。
  3. 对照 references/api-dev.md 检查 Plugin 类型、钩子名称以及 0.8.7 版本引入的 template 能力。
  4. 在插件自己的 tests/ 下添加测试;单体仓库的 pnpm prep 会运行通用安全网。

3. 编写模板

  1. 阅读 references/template-development.md 了解 12 个模板插槽和资源管道。
  2. 匹配现有模板(packages/templates/summer/ 是参考)使用的 manifest 结构。
  3. 对照 references/api-dev.md 中的 TemplateSlot 联合类型验证(没有 header 插槽 — 共有 12 个)。

4. 引擎工作

  1. 首先阅读 references/engines.md — 确认目标引擎及其配置键。
  2. 对于引擎加载器的 Node 级别更改,查阅 references/api-dev.md § “Engine Loader API”。

跨技能导航

  • docmd-skills — 用于站点级别工作;默认优先加载。
  • docmd-writer — 当任务涉及模板演示或示例文档中的散文质量时加载。

相关技能