@ 农地/ nuxt

Nuxt 和 Nitro 运行时适配器 @farming-labs/docs。 。 。 .

它从 Nitro 存储器中装入 Markdown 和 MDX 的内容, 构建导航, 使页面内容打开 服务器,并提供 H3 处理器用于文档、搜索、AI、代理发现、MCP和API 参考.

一揽子责任

• @farming-labs/docs ——共享配置,类型,内容特征,以及CLI
• @farming-labs/nuxt • 硝基含量加载和服务器处理器
• @farming-labs/nuxt-theme ——Vue布局和UI组件
• @farming-labs/theme ——共享预设CSS

安装

CLI可以连接完整的Nuxt集成:

npx @farming-labs/docs@latest init

手动安装 :

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

服务器集成

创建主 Nitro API 处理器 :

// server/api/docs.ts
import { defineDocsHandler } from "@farming-labs/nuxt/server";
import config from "../../docs.config";

export default defineDocsHandler(config, useStorage);

生成的设置还添加了公用路由中间软件 defineDocsPublicHandler() 并创造 通过 Nitro 存储可用的文件目录 :

// nuxt.config.ts
export default defineNuxtConfig({
  css: ["@farming-labs/theme/default/css"],
  nitro: {
    moduleSideEffects: ["@farming-labs/nuxt/server"],
    serverAssets: [{ baseName: "docs", dir: "docs" }],
  },
});

以 DocsLayout 财务报告和审定财务报表 DocsContent 从 @farming-labs/nuxt-theme。 。 。 .

主要入境点

学多点

• 文档
• Nuxt 实例
• GitHub 仓库

许可证

麻省理工学院