# @farming-labs/tanstack-start 中文文档

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

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

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

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

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

- 包体积（解压后）：197 kB，26 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- peer 依赖：react ^19\.0\.0，@farming-labs/docs \>=0\.2\.73 \|\| ^0\.2\.133-perf\.0，@farming-labs/theme \<0\.2\.133 \|\| \>=0\.2\.133-perf\.0
- 首次发布：2026-03-15T11:10:59.717Z
- 最新版本发布：2026-11-13T20:35:52.843Z
- 近 30 天下载量：5661（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：276（近 12 个月 276 个）

## 中文简介

TanStack 为@farming-labs/docs启动适配器——内容加载,搜索和AI公用事业

## 安装

```sh
npm install @farming-labs/tanstack-start
```

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

## README

# @ farming-labs/ tanstack- start

TanStack 启动适配器 [`@farming-labs/docs`](https://www.npmjs.com/package/@farming-labs/docs)。 。 。 .

它用 Vite 编译 Markdown 和 MDX, 载入服务器上的文档内容, 构建 导航和页面元数据,显示文档和 MCP 处理器,并与 Farming 制作页面 实验室反应主题.

## 这个软件包做什么

-   将农作实验室 MDX 管道添加到 Vite
-   装入文件系统内容并构建服务器上的导航树
-   为页面、搜索、AI、代理发现、MCP和API提供处理器
-   用品 `TanstackDocsPage` TanStack 路由器路线的反相渲染器

共享配置和 CLI 生活在 `@farming-labs/docs`. 供应商、反应UI、MDX组件以及 主题 CSS 生活于 `@farming-labs/theme`。 。 。 .

## 安装

CLI可以脚手架 完全融合:

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

手动安装 :

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

## 最小设置

在 TanStack 启动插件前添加 Docs MDX 插件 :

```ts
// vite.config.ts
import { tanstackStart } from "@tanstack/react-start/plugin/vite";
import { docsMdx } from "@farming-labs/tanstack-start/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [docsMdx(), tanstackStart()],
});
```

创建服务器集成 :

```ts
// src/lib/docs.server.ts
import { createDocsServer } from "@farming-labs/tanstack-start/server";
import docsConfig from "../../docs.config";

export const docsServer = createDocsServer({
  ...docsConfig,
  rootDir: process.cwd(),
});
```

用回放适配器加载了页面数据 :

```tsx
import { TanstackDocsPage } from "@farming-labs/tanstack-start/react";

<TanstackDocsPage config={docsConfig} data={loaderData} />;
```

完全的整合还需要docs和API路线, `RootProvider` 从 `@farming-labs/theme/tanstack`,以及选定的主题 CSS。 CLI创建了这些文件.

## 主要入境点

| 入境点 | 目的 |
| --- | --- |
| `@farming-labs/tanstack-start/vite` | Vite MDX 编译插件 |
| `@farming-labs/tanstack-start/server` | 内容加载和Docs API/MCP处理器 |
| `@farming-labs/tanstack-start/react` | `TanstackDocsPage` 渲染器 |
| `@farming-labs/tanstack-start/content` | 低级内容和导航设施 |
| `@farming-labs/tanstack-start/api-reference` | API 参考路由处理器 |

## 学多点

-   [文档](https://docs.farming-labs.dev/docs)
-   [TanStack 启动示例](https://github.com/farming-labs/docs/tree/main/examples/tanstack-start)
-   [GitHub 仓库](https://github.com/farming-labs/docs)

## 许可证

麻省理工学院

## 常见问题

### @farming-labs/tanstack-start 是什么？

TanStack 为@farming-labs/docs启动适配器——内容加载,搜索和AI公用事业

### 如何安装 @farming-labs/tanstack-start？

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

### @farming-labs/tanstack-start 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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