✨ 亮点
此版本正式确立了 docmd 作为领先的 “AI-First”(AI 优先)文档引擎的地位。核心升级是一个原生 Model Context Protocol (MCP) 服务端,使 AI Agent 能够通过 docmd mcp 与文档工作区交互。此外,此版本还提供了一个模块化 Agent 技能集(docmd-skills)、官方 Docker 镜像(支持多架构)、客户端"复制 Markdown"和"复制上下文"组件、CJK 及无空格语言的搜索分词引擎重构,以及对目录(TOC)布局的关键优化。
🔌 原生 Model Context Protocol (MCP) 服务端
您现在可以直接在工作区中启动原生的 MCP 服务端:
docmd mcp
该服务端运行于本地 stdio 模式(协议版本 2025-03-26),允许 AI 开发 Agent(如 Claude Desktop、Cursor 或 Windsurf)安全地连接您的文档工作区:
- 执行全文及语义文档搜索(
search_docs) - 读取 Markdown 文件和配置信息(
read_doc) - 执行超链接与相对路径校验(
validate_docs) - 获取统一的仓库上下文(
get_llms_context)
完整的协议合规性,包括 ping 健康检查和 notifications/initialized 生命周期。
📖 模块化 Agent 技能集(docmd-skills)
在运行 docmd init 时,会在项目根目录生成一个版本化的 SKILL.md 文件。完整的技能集作为模块化集合维护在 docmd-skills 仓库中:
cli.md:安装、所有 CLI 命令及其选项和标志。config.md:完整的docmd.config.jsonSchema,包含默认值和内联注释。plugins.md:每个内置插件的所有配置键、默认值和行为说明。plugin-development.md:Hook 签名、生命周期、ActionContext、自定义插件创建指南。formatting.md:容器语法、Frontmatter 参考、自闭合规则。api.md:Node.js 构建 API、浏览器 API、MCP 服务端、URL 工具函数、客户端事件。validation.md:链接检查和 CI/CD 集成。
所有技能文件均包含解释默认值的内联注释、完整文档的参考链接以及 llms-full.txt 可发现性指南。
🐳 官方 Docker 镜像
docmd 现已提供官方 Docker 镜像,支持多架构(linux/amd64 和 linux/arm64):
docker pull ghcr.io/docmd-io/docmd:latest
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:latest build
包括 Docker Compose 和 Kubernetes 部署示例、非 root 安全运行、Alpine Linux 基础镜像、健康检查及 GitHub Actions CI/CD 集成。
🧠 AI-First 上下文提取组件
为了使 AI 助手能够无缝摄取文档内容,我们在页面面包屑导航旁引入了两个全新的本地化按钮:
- 复制 Markdown:复制清理后的文档正文,自动剥离 YAML 前言元数据。
- 复制上下文:复制结构化的上下文信息,包含页面 URL、标题、标签、版本及全文。
- 本地化支持:支持所有 7 种主要语言(
en、de、es、fr、hi、ja、zh)。
🔍 无空格语言搜索分词(中日韩、泰语、老挝语等)
我们解决了 MiniSearch 搜索索引在处理词与词之间不使用空格的语言时的局限性。新版本引入了统一的 CJK_AND_SPACELESS_REGEX 分词器,对称运行于构建时索引生成器、多线程后台工作线程和客户端浏览器查询解析器。
🔢 docmd-search 0.1.0-alpha.1
此版本集成了 docmd-search 0.1.0-alpha.1,修复了搜索结果置信度百分比可能超过 100% 的关键 bug。
📚 目录(TOC)增强
目录组件获得了显著改进:H1 标题现已正确包含在目录中。TOC 侧边栏支持独立滚动,活跃目录项自动居中,并使用去抖的平滑滚动。
更新日志
- MCP:实现了运行于本地 stdio 的原生
docmd mcp服务端功能。 - MCP:协议更新至
2025-03-26— 添加ping处理器,修复notifications/initialized生命周期。 - MCP:修复了
readline输出污染导致 JSON-RPC 流损坏的问题。 - MCP:新增专门的 MCP 服务端文档页面。
- Skills:将 Agent 手册模块化为
docmd-skills/目录下的 7 个技能文件。 - Skills:新增
api.md和plugin-development.md模块。 - Skills:新增
llms-full.txt可发现性指南和 Agent 使用说明。 - Docker:新增官方 Docker 镜像,支持多架构(amd64/arm64)。
- Docker:新增 Docker Compose、Kubernetes 和 GitHub Actions 部署示例。
- Docker:非 root 安全运行、Alpine 基础镜像、健康检查、SBOM 认证。
- AI:新增"复制 Markdown"和"复制上下文"UI 组件,并支持 7 种语言的本地化。
- Search:在 MiniSearch 中为中日韩、泰文、老挝文、高棉文、缅甸文和藏文脚本添加了统一分词器。
- TOC:支持 H1 标题并应用相应的锚点链接和样式。
- TOC:为 TOC 侧边栏实现了独立滚动。
- TOC:活跃目录项自动居中,使用去抖的平滑滚动。
- TOC:扩展滚动监听以同时观察 H1 和 H2-H4 标题。
- Parser:更新标题锚点注入,使 H1 标题也包含永久链接图标。
- UI:修复了因 TOC 溢出引起的页脚渲染问题。
- Search:修复了 docmd-search 0.1.0-alpha.1 中的置信度百分比计算。
- UI:升级 Steps 步骤组件,实现精确对齐、悬停状态和发光的品牌色节点。
- UI:重构 Changelog 更新日志时间线,采用连续的网格轴和交互式可扩展标记。
- UI:在内容页面顶部添加现代自适应径向光晕效果(适配亮/暗模式)。
- UI:将复制小部件重新设计为统一、美观的分段控制按钮组。
- UI:修复了一个关键的 SPA 路由错误——在客户端导航期间,由于相对路径解析偏移,head 资源(样式表和图标)会被重复注入。
感谢 💖
感谢所有报告问题并提供反馈的贡献者和社区成员。
官方文档:https://docs.docmd.io/
GitHub 仓库:https://github.com/docmd-io/docmd