@ 农地/ astro

Astro 运行时间适配器 @farming-labs/docs。 。 。 .

它加载了Markdown和MDX的内容,构建了导航,使服务器上的页面内容,以及 提供Astro处理器,用于文档,搜索,AI,代理发现,MCP,和API参考.

一揽子责任

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

安装

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

npx @farming-labs/docs@latest init

手动安装 :

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

动态 Docs 路由还需要一个 Astro 服务器适配器, 如 @astrojs/vercel, (中文(简体) ), @astrojs/netlify, (中文(简体) ), @astrojs/node,或 @astrojs/cloudflare。 。 。 .

服务器集成

使用 Vite 预装内容并创建 Docs 服务器 :

// src/lib/docs.server.ts
import { createDocsServer } from "@farming-labs/astro/server";
import config from "./docs.config";

const contentFiles = import.meta.glob("/docs/**/*.{md,mdx}", {
  query: "?raw",
  import: "default",
  eager: true,
}) as Record<string, string>;

export const { load, GET, HEAD, POST, MCP } = createDocsServer({
  ...config,
  _preloadedContent: contentFiles,
});

打电话 load(Astro.url.pathname) 从文件页中生成结果,并附带组件 @farming-labs/astro-theme。 CLI 生成页面、 API 路由、 公共转发、 主题 CSS导入,以及Astro适配器配置.

主要入境点

学多点

• 文档
• 天体实例
• GitHub 仓库

许可证

麻省理工学院