# @farming-labs/theme 中文文档

规范地址：https://npmcn.com/package/%40farming-labs/theme/

版本：0\.2\.146
npm 元数据更新时间：2026-11-13T20:32:06.277Z
中文译文更新时间：2026-11-14T10:33:37.987Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40farming-labs/theme
原文对照：https://npmcn.com/package/%40farming-labs/theme/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.6 MB，131 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：next \>=16\.0\.0，react \>=19\.2\.0，react-dom \>=19\.2\.0，@farming-labs/docs ^0\.2\.146
- 首次发布：2026-02-18T22:44:49.752Z
- 最新版本发布：2026-11-13T20:32:06.074Z
- 近 30 天下载量：88260（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：378（近 12 个月 378 个）

## 中文简介

@farmining-labs/docs——布局、提供者、MDX组件和样式的主题包

## 安装

```sh
npm install @farming-labs/theme
```

也可以使用：`pnpm add @farming-labs/theme`、`yarn add @farming-labs/theme`、`bun add @farming-labs/theme`

## README

# @农地/主题

React UI 层和共享主题预设软件包 [`@farming-labs/docs`](https://www.npmjs.com/package/@farming-labs/docs)。 。 。 .

它提供 docs shell, root 提供者, MDX 组件, 搜索和 AI 接口, 主题 工厂和CSS在每一个农作实验室框架的整合中使用.

## 合适的话

-   **Next.js 和 TanStack 开始 :** 提供反应布局、提供者、组件和CSS
-   **斯维尔特基特,阿斯特罗,和努克特:** 匹配时共享预设的 CSS `*-theme` 软件包 供应框架内置UI组件
-   **`@farming-labs/docs`数字 :** 提供共享配置、内容特性和CLI

## 安装

下一个.js:

```bash
npm install @farming-labs/docs @farming-labs/next @farming-labs/theme
```

对于 TanStack 启动 :

```bash
npm install @farming-labs/docs @farming-labs/tanstack-start @farming-labs/theme
```

设置 CLI 自动安装正确的包集 :

```bash
npx @farming-labs/docs@latest init
```

## 选择主题

使用主题工厂 `docs.config.ts`数字 :

```ts
import { defineDocs } from "@farming-labs/docs";
import { fumadocs } from "@farming-labs/theme";

export default defineDocs({
  entry: "docs",
  theme: fumadocs(),
});
```

然后输入它的CSS. 默认 `fumadocs()` 预设使用 `default/css` 切入点 :

```css
@import "tailwindcss";
@import "@farming-labs/theme/default/css";
```

其他预设使用匹配厂和 CSS 子路径 :

```ts
import { hardline } from "@farming-labs/theme/hardline";
```

```css
@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 .

## 学多点

-   [主题](https://docs.farming-labs.dev/docs/themes)
-   [创建主题](https://docs.farming-labs.dev/docs/themes/creating-themes)
-   [GitHub 仓库](https://github.com/farming-labs/docs)

## 许可证

麻省理工学院

## 常见问题

### @farming-labs/theme 是什么？

@farmining-labs/docs——布局、提供者、MDX组件和样式的主题包

### 如何安装 @farming-labs/theme？

在项目目录运行 npm install @farming-labs/theme，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@farming-labs/docs（^0\.2\.146）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @farming-labs/theme 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @farming-labs/theme 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @farming-labs/theme 可以商用吗？

@farming-labs/theme 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @farming-labs/theme 的下载量有多少？

根据 npm 官方下载统计，@farming-labs/theme 在 2026/10/15 – 2026/11/13 这 30 天内被下载 88,260 次，日均约 2,942 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @farming-labs/theme 还在维护吗？

最新版本 0\.2\.146 发布于 2026/11/14（今天）；至今共发布 378 个版本，其中过去 12 个月发布了 378 个；首次发布于 2026/02/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

