# @farming-labs/next 中文文档

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

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

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

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

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

- 包体积（解压后）：211 kB，44 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：13 个
- peer 依赖：next \>=16\.0\.0，react \>=19\.2\.0，react-dom \>=19\.2\.0，@farming-labs/docs \>=0\.2\.121 \|\| ^0\.2\.133-perf\.0，@farming-labs/theme \>=0\.0\.1 \|\| ^0\.2\.133-perf\.0
- 首次发布：2026-02-16T23:55:49.191Z
- 最新版本发布：2026-11-13T20:32:49.233Z
- 近 30 天下载量：22359（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：379（近 12 个月 379 个）

## 中文简介

下一位 js 适应器, 用于 @ farmining- labs/ docs — MDX 配置包装器

## 安装

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

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

## README

# @ 农作- labs/ next

Next.js App 路由器适配器 [`@farming-labs/docs`](https://www.npmjs.com/package/@farming-labs/docs)。 。 。 .

它将共享的docs配置和主题连接到Next.js,编译了Markdown和MDX, 生成标准 Docs 路由,并为文档提供下一级运行时帮助 APIs,API参考文献,MCP,和更改日志.

## 这个软件包做什么

-   环绕 `next.config.ts` 与农业实验室MDX和路由整合
-   生成缺失的文档布局, API 路由, MCP 路由, 并启用特性路由
-   添加机器可读的Markdown、代理发现、站点图和 `llms.txt` 重写
-   提供 App 路由器布局、元数据、 API 引用和更改日志帮助
-   保存用户授权的文件和现有的 Next.js 配置

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

## 安装

CLI 可以在已有的 Next.js 项目中添加文件:

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

手动安装 :

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

## 最小设置

创建 `docs.config.ts` 与 `defineDocs()`,然后将 Next.js 配置:

```ts
// next.config.ts
import { withDocs } from "@farming-labs/next/config";

export default withDocs();
```

现有的 Next.js 配置可以直接传递:

```ts
export default withDocs({
  reactStrictMode: true,
});
```

在全局样式表中导入所选主题 :

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

在下面写入文档页 `app/docs/` 或者说 `src/app/docs/`。 CLI 还添加了根 `RootProvider`,生成的docs布局,以及完整设置所需的服务器路径.

## 扩展 MDX 汇编

设定 `mdx` 内 `docs.config.ts` 并传递现场配置 `withDocs`。插件模块名称和 使用 JSON 选项的路径与 Webpack 和 Turbopack 都工作:

```ts
export default defineDocs({
  entry: "docs",
  mdx: {
    remarkPlugins: ["remark-directive", "./lib/remark-docs.mjs"],
    rehypePlugins: [["rehype-external-links", { target: "_blank" }]],
  },
});
```

```ts
import { withDocs } from "@farming-labs/next/config";
import docsConfig from "./docs.config";

export default withDocs({}, docsConfig);
```

在应用程序中安装插件 。 从路径开始 `./` 或者说 `../` 解析 应用程序根。 额外的插件在它们各自的阶段内置插件之后运行; 前题,标题 ID, TOC, Markdown 替代链接, 语法突出显示仍然启用 . 在本地插件模块中放回调和其他非JSON配置.

对于一个具有自身亮点的迁移,设置 `mdx.codeHighlighter` 到该插件的模块名称 或者说 `[module, options]` tu. 这只取代默认的代码高亮步骤, 所以代码是 突出显示一次。 自定义插件拥有其主题和代码块行为. 选择 `mdx` 保留 现有默认值。 这些钩子不配置 Fumadocs 收藏或替换其来源 加载器.

第三个论点 `withDocs(nextConfig, docsConfig, { mdx })` 形式被贬损,仍然有效. 设置 `mdx` 在两个地方都扔.

内置突出显示器在编译过程中使用Shiki的Oniguruma引擎. 自定义亮点 能够导入 `@farming-labs/next/mdx-plugins/rehype-code` 在配置时保留默认值 主题和变压器。 通过 `engine: "js"` 明确选择Shiki的JavaScript引擎.

## 页面元数据传输

制作结构 发送标题、描述、阅读时间、日期和结构数据 兼容的Markdown/MDX页面. 共享布局保持了导航和主题设置. 这个变化 ,而不修改已渲染的页面标记或主题 API.

使用生成的标准布局和 MDX 自动选择适用于普通文件路径 供养. 自定义布局、 MDX 提供者、 编译器扩展, `components.wrapper`发展, 本地化布局, 多个文件根, 自定义内容目录, Next.js `basePath`,筑起 版式/平板、动态/组/平行路由,以及作者的 MDX 导出保留现有 全站元数据路径。 含有出口品的密码栅栏仍符合条件。 已安装的旧核心或 没有边界支持的主题包也保留了现有的路径.

明确保留全站元数据:

```ts
export default withDocs({}, undefined, { pageMetadata: "site" });
```

默认是 `pageMetadata: "auto"`。两种传输方式使用相同的元数据构建器和页面 组件。 自定义编译器扩展保留了现有的传输. 边界 子路径是内部编译器集成点,而不是应用程序组件 API.

## 主要入境点

| 入境点 | 目的 |
| --- | --- |
| `@farming-labs/next/config` | `withDocs()` 下一个.js 配置包装器 |
| `@farming-labs/next/layout` | App 路由器文件布局和元数据助手 |
| `@farming-labs/next/api` | Docs API 和 MCP 路由处理器 |
| `@farming-labs/next/api-reference` | 生成的 API 参考路径和页面 |
| `@farming-labs/next/changelog` | 生成更改日志页面帮助器 |

## 所需资源

-   Next.js 16 或更新
-   反应和反应 DOM 19.2 或更新
-   `@farming-labs/docs` 6.2.121 或较新和 `@farming-labs/theme`

## 学多点

-   [文档](https://docs.farming-labs.dev/docs)
-   [Next.j 实例](https://github.com/farming-labs/docs/tree/main/examples/next)
-   [GitHub 仓库](https://github.com/farming-labs/docs)

## 许可证

麻省理工学院

## 常见问题

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

下一位 js 适应器, 用于 @ farmining- labs/ docs — MDX 配置包装器

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

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

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

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

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

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

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

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

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

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

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

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