@ 农作- labs/ next

Next.js App 路由器适配器 @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 项目中添加文件:

npx @farming-labs/docs@latest init

手动安装 :

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

最小设置

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

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

export default withDocs();

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

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

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

@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 都工作:

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

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 导出保留现有 全站元数据路径。 含有出口品的密码栅栏仍符合条件。 已安装的旧核心或 没有边界支持的主题包也保留了现有的路径.

明确保留全站元数据:

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

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

主要入境点

所需资源

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

学多点

• 文档
• Next.j 实例
• GitHub 仓库

许可证

麻省理工学院