SuperAPI AI 工具集

getting-started

前端与建站

查看项目

更新于 10-15 21:40

技能介绍

用途:@farming-labs/docs 是 MDX 文档框架,写 Markdown 即可生成文档站点,支持 Next.js、TanStack Start、Farm.js、SvelteKit、Astro、Nuxt。

主要能力:内置 12 套可选主题(如 fumadocs、shadcn、ledger 等),支持自定义主题脚手架;内置 Callout、Tabs、Agent、Human、Audience 等 MDX 组件;支持页面反馈、页面操作、Next.js 变更日志页;默认启用 MCP 服务器(/mcp、/.well-known/mcp);提供 /docs.md 与 /docs/<slug>.md 机器可读 Markdown 路由、AGENTS.md、robots.txt、Schema.org JSON-LD 结构化数据及代理发现端点。

使用方式:交互式初始化用 npx @farming-labs/docs@latest init;从零创建用 npx @farming-labs/docs@latest init --template <next|tanstack-start|nuxt|sveltekit|astro> --name <project-name>;升级用 npx @farming-labs/docs@latest upgrade。配置集中在 docs.config.ts 的 defineDocs(),需按框架安装对应适配器与主题包,并在全局样式中导入主题 CSS,否则页面无样式。

适用场景:为各类前端框架快速搭建文档站,并让 AI 代理读取结构化文档内容。

限制:静态导出需设 staticExport: true,此时搜索与 AI 聊天隐藏;非 Next.js 框架的 API 参考需手动添加处理路由;内置变更日志页目前仅 Next.js 支持;受众过滤不是身份验证,不可放置机密信息。具体收费与价格暂未提供。