公司动态
Context Hub 内容仓库完全解析:Markdown + Frontmatter 组织数千篇 API 文档
Context Hub 内容仓库完全解析Markdown Frontmatter 组织数千篇 API 文档【免费下载链接】context-hub项目地址: https://gitcode.com/gh_mirrors/co/context-hubContext Hub 是一个面向 AI 编程代理的 API 文档内容仓库用纯 Markdown YAML Frontmatter 组织成百上千篇带版本、分语言的开发者文档让 AI 写代码时不再幻觉 API而是读取经过精选维护的真实参考。读完本文你将完整看懂它的目录结构、元数据格式、文档组织规则以及如何上手搜索、获取甚至贡献内容。 内容仓库到底解决什么问题AI 编程助手如 Claude Code、Cursor常因训练数据过期而编造不存在的 API。Context Hub 的思路很直接把所有精选文档以 Markdown 形式开源维护在仓库里你的代理每次写代码前先拉取最新文档而不是凭记忆猜。所有内容由 README.md 概括纯 Markdown YAML frontmatter可审查、可贡献文档按项目名 / 主题 / 语言三级目录组织天然支持同一 API 的 Python、JavaScript、TypeScript 多语言版本配套chub命令行工具见 cli/README.md代理通过它搜索、获取、标注、投票反馈 目录结构一个项目一个文件夹内容全部位于content/目录下每个项目如 aiohttp、Ansible、Apache Airflow占一个独立文件夹。以 aiohttp 为例标准结构是content/aiohttp/docs/package/python/DOC.md三层含义一目了然层级含义示例项目名第三方库或服务aiohttp、anthropic、ansible主题package / 具体 API / 子模块package、claude-api、cors语言代码版本语言python、javascript、typescript入口文件统一命名为DOC.md例如 content/aiohttp/docs/package/python/DOC.md 或 content/anthropic/docs/claude-api/python/DOC.md。一个项目可以有多个主题文档如anthropic下既有package又有claude-apiAirflow 则为每个 provider 单独建了目录。️ Frontmatter每篇文档的身份证每篇DOC.md开头都是一段 YAML frontmatter这是整个仓库检索能力的核心。以 aiohttp 文档开头为例--- name: package description: aiohttp package guide for Python - async HTTP client/server... metadata: languages: python versions: 3.13.3 revision: 1 updated-on: 2026-03-11 source: maintainer tags: aiohttp,python,asyncio,http,web,websocket ---关键字段解读description一句话摘要供搜索排序和人工快速判断versions精确版本号如3.13.3保证代理拿到与代码库匹配的 APIrevision/updated-on修订号和更新日期判断内容新鲜度source维护者标注如maintainertags逗号分隔标签是 BM25 全文检索的重要输入检索实现见 cli/src/lib/bm25.jsfrontmatter 的解析逻辑在 cli/src/lib/frontmatter.js文档索引与检索由 cli/src/lib/registry.js 统一调度——工具链与内容仓库完全解耦。 如何搜索与获取文档安装chub后三个命令覆盖 90% 场景chub search stripe payments # 按关键词搜索 chub get openai/chat --lang py # 按 ID 语言获取 chub get id --file xxx # 增量获取指定参考文件节省 token这套搜索 → 获取 → 使用的工作流被固化成一份 Agent Skillcli/skills/get-api-docs/SKILL.md。把它放进代理的 skills 目录后代理会在写代码前自动拉取最新文档而不是依赖过期的预训练记忆。 让仓库越用越聪明标注与反馈内容仓库不是一次性产物而是一个反馈闭环本地标注chub annotate id 注意事项把踩坑记录挂在文档上跨会话保留社区反馈chub feedback id up|down把真实使用评分送回给文档作者持续改进作者依据反馈修订DOC.md所有人受益代理侧的完整闭环指引搜索、获取、标注、反馈四步详见 cli/skills/get-api-docs/SKILL.md。✍️ 参与贡献提交一篇文档有多难因为内容就是纯 Markdown贡献门槛极低——API 提供方、框架作者、社区任何人都可以提交。格式规范和目录约定参考 CONTRIBUTING.md 与 README.md 中的 Content Types 说明新建content/项目名/docs/主题/语言/DOC.md写好 frontmatter 元数据正文遵循Golden Rule → Install → 使用示例的结构即可。 核心路径速查路径说明content/全部内容文档按项目/主题/语言组织cli/chub命令行工具源码搜索、获取、标注、反馈cli/src/mcp/MCP Server 实现供代理直接调用cli/skills/get-api-docs/SKILL.md教代理使用 chub 的技能文件CONTRIBUTING.md贡献指南一句话总结Context Hub 用目录即分类、Frontmatter 即元数据、Markdown 即内容的极简方案把数千篇 API 文档组织成 AI 代理可直接检索、版本可控、社区可持续改进的知识库——这正是它最值得借鉴的设计。【免费下载链接】context-hub项目地址: https://gitcode.com/gh_mirrors/co/context-hub创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考