SuperAPI AI 工具集

using-docs-kit

前端与建站

查看项目

更新于 10-16 06:23

技能介绍

用途:@lobehub/docs-kit 用于搭建并编写静态文档站,基于 React Router + Vite,lobe-ui 的 ui.lobehub.com 即由它生成。消费仓库只需保存内容与 docs.config.ts,Vite 和 React Router 配置由该工具包管理,除非需要覆盖,否则不要添加 vite.config.ts 或 react-router.config.ts。

仓库结构:根目录含 docs.config.ts(必需)、package.json、docs/(index.mdx 必需,changelog.mdx 可选)、src/(每个组件目录含 index.ts 桶导出、组件、type.ts、index.mdx、demos/)、public/ 与 CHANGELOG.md。编译规则:只有 atomDirs 根下名为 index.mdx 的文件会成为组件页;Demo 必须位于 src//demos/;docs 下其他 mdx 需在 publicDocs 列出。

安装与脚本:pnpm add -D @lobehub/docs-kit @react-router/dev@8.2.0 react-router@8.2.0 vite@8.1.4 tsx,再装 react react-dom ^19;脚本为 docs:dev、docs:build、postinstall 的 lobedocs typegen。lobedocs build 输出到 dist/,自动生成 Pagefind 搜索、sitemap、/llms.txt、/skills.md,要求 Node >= 22.22。

配置:docs.config.ts 导出普通对象,包含 atomDirs、title、description、siteUrl、alias、themeConfig.apiHeader.packageName 与 socialLinks 等;改配置后需重启 lobedocs dev。唯一稳定 JS 入口是 @lobehub/docs-kit/react-router-config,没有 defineDocsConfig 的根导出。

组件页:frontmatter 的 title、description、category 必填,order、status、since、route 可选;URL 由目录推导。正文从 ## 开始,Demo 使用 ?demo 导入与 <Demo>,API 表使用 <Api name>,props 从 TypeScript 与 JSDoc 提取,@default 必须与运行时默认值一致。

适用与限制:适合组件库文档站;指南页、首页、changelog 有专门约定。构建失败会列出文件与规则,其他细节暂未提供。