@农地/主题
React UI 层和共享主题预设软件包
@farming-labs/docs。 。 。 .
它提供 docs shell, root 提供者, MDX 组件, 搜索和 AI 接口, 主题 工厂和CSS在每一个农作实验室框架的整合中使用.
合适的话
- Next.js 和 TanStack 开始 : 提供反应布局、提供者、组件和CSS
- 斯维尔特基特,阿斯特罗,和努克特: 匹配时共享预设的 CSS
*-theme软件包 供应框架内置UI组件 @farming-labs/docs数字 : 提供共享配置、内容特性和CLI
安装
下一个.js:
npm install @farming-labs/docs @farming-labs/next @farming-labs/theme
对于 TanStack 启动 :
npm install @farming-labs/docs @farming-labs/tanstack-start @farming-labs/theme
设置 CLI 自动安装正确的包集 :
npx @farming-labs/docs@latest init
选择主题
使用主题工厂 docs.config.ts数字 :
import { defineDocs } from "@farming-labs/docs";
import { fumadocs } from "@farming-labs/theme";
export default defineDocs({
entry: "docs",
theme: fumadocs(),
});
然后输入它的CSS. 默认 fumadocs() 预设使用 default/css 切入点 :
@import "tailwindcss";
@import "@farming-labs/theme/default/css";
其他预设使用匹配厂和 CSS 子路径 :
import { hardline } from "@farming-labs/theme/hardline";
@import "@farming-labs/theme/hardline/css";
可用的预设子路径包括 default, (中文(简体) ), darksharp, (中文(简体) ), pixel-border, (中文(简体) ), colorful, (中文(简体) ), shiny, (中文(简体) ),
darkbold, (中文(简体) ), greentree, (中文(简体) ), hardline, (中文(简体) ), concrete, (中文(简体) ), command-grid, (中文(简体) ), ledger, (中文(简体) ), shadcn,以及 threadline。 。 。 .
这个 shadcn 预设使用平平的桌面目录,没有装饰性栏杆. 活动
区域使用文本颜色;移动弹出器保持其缩进的铁路和向导导航.
主要入境点
createDocsLayout() 一起编写导航和页面元数据,每页读取一次
准备证。 在生产中,跨页数据产生的布局再利用在相同范围内
布局实例,包括静态生成 next build。内容变化被接受
通过新的构建/进程; 开发使数据刷新以反映编辑、新页和
删除页面。 不需要额外的配置.
| 入境点 | 目的 |
|---|---|
@farming-labs/theme | 默认主题, RootProvider,布局辅助工具,以及反演UI |
@farming-labs/theme/<preset> | 预设主题工厂 |
@farming-labs/theme/<preset>/css | 完成预设的 CSS |
@farming-labs/theme/mdx | 农场实验室 MDX 组件地图 |
@farming-labs/theme/search | 遗产 createDocsSearchAPI() 兼容性帮助 |
@farming-labs/theme/ai | AI 搜索和聊天 UI |
@farming-labs/theme/tanstack | TanStack 启动提供者和布局集成 |
DocsCommandSearch 保持其键盘和搜索按钮触发器在页面负载时可用.
首先使用的对话框加载, 显示可忽略的加载状态, 并保留最近的搜索
和缓存结果 交叉关闭。 这种行为由Next.js、TanStack Start 分享
浏览器运行时间布局.
运行时间要求
软件包目前宣布Next.js 16+,回放19.2+,回放DOM 19.2+为对等方,因为它 根切入点提供 React 和 Next.js UI。 SvelteKit、 Astro 和 Nuxt 集成消耗 共享 CSS 子路径,同时通过框架内置主题包渲染 UI .
学多点
许可证
麻省理工学院