@ farming-labs/ tanstack- start

TanStack 启动适配器 @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可以脚手架 完全融合:

npx @farming-labs/docs@latest init

手动安装 :

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

最小设置

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

// 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()],
});

创建服务器集成 :

// 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(),
});

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

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

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

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

主要入境点

学多点

• 文档
• TanStack 启动示例
• GitHub 仓库

许可证

麻省理工学院