用途:为 @farming-labs/docs 配置 docs.config.ts(或 .tsx),涵盖 entry、contentDir、theme、staticExport、navigation、search、feedback、agent surfaces、MCP 等选项族。
主要能力:按选项族提供聚焦参考,包括核心配置、Agent 内容与发现(Markdown 协商、受众投影、契约、llms.txt、sitemap、robots)、Agent Skills 与评估、搜索与反馈、MCP 与 API 参考。
使用方式:先确认框架、包根目录、配置路径、包管理器与已安装版本;编辑前读取现有配置与导入,保留请求之外的 callback、主题工厂、自定义适配器和框架接线;用 defineDocs() 实现选项;密钥放环境变量。配置位置:Next.js 与 TanStack Start、Farm.js、Nuxt 用根目录 docs.config.ts[x](Next 需 withDocs() 包裹,Farm.js 用 withDocs() 包裹 defineConfig());SvelteKit 与 Astro 用 src/lib/docs.config.ts。最小形态为 defineDocs({ entry: "docs", theme: fumadocs() })。
验证:pnpm typecheck、pnpm build、pnpm exec docs doctor --agent --config docs.config.tsx,仅运行 package.json 中存在的命令。
限制:staticExport: true 会禁用仅服务端搜索与 AI 行为;受众块不是访问控制,不得放入密钥;MCP HTTP 默认公开,仅在明确需要时加 mcp.security.authenticate;保持 mcp.route 与非 Next 公共转发器同步;配置中只存环境变量名;API 在别处时用托管 OpenAPI specUrl。若配置求值失败,检查导入与环境访问,不要静默替换为静态近似。