用途:@farming-labs/docs 是一个基于 MDX 的现代文档框架,用 Markdown/MDX 编写内容即可生成文档站点,支持 Next.js、SvelteKit、Astro、Nuxt 四种框架。
主要能力:提供 CLI 初始化、文件路由、frontmatter(title、description、icon)、七种内置主题(fumadocs、darksharp、pixel-border、colorful、greentree、darkbold、shiny),并可通过 defineDocs 统一配置。
使用方式:在已有项目中运行 npx @farming-labs/docs@latest init;从零创建项目运行 npx @farming-labs/docs@latest init --template <next|nuxt|sveltekit|astro> --name <project-name>。CLI 支持 --theme、--entry 等参数。各框架需安装对应核心与适配器包及主题包,例如 Next.js 用 @farming-labs/docs、@farming-labs/next、@farming-labs/theme。配置使用 docs.config.ts 中的 defineDocs,并设置 entry、contentDir、theme、metadata 等。
关键限制:必须在全局样式导入主题 CSS,否则页面无样式;主题名需与 CSS 导入路径一致;不同框架须使用对应主题包。若需完全静态构建(如 Cloudflare Pages),可在 defineDocs 中设置 staticExport: true,此时搜索与 AI 功能会被隐藏且无需服务器。
适用场景:为上述框架快速搭建文档站点。其他细节暂未提供。