next/ai-ready
EN

api reference

配置

ai-ready.config.mjs 的完整参考。

ai-ready.config.mjs 是配置 next-ai-ready 的唯一入口文件，位于项目根目录。

defineConfig

js
import { defineConfig } from "@next-ai-ready/core";

export default defineConfig({
  site: { ... },
  content: [ ... ],
  actions: "./actions/index.mjs",
  emit: { ... },
});

site

站点级元数据，用于 llms.txt、OpenAPI 和 JSON-LD。

字段类型必填描述
namestring是站点或产品名称
baseUrlstring是生产环境 URL（用于 canonical 链接）
descriptionstring是面向 AI 消费者的简短描述

content

指向 MDX 内容文件的 glob 模式数组：

js
content: ["app/**/*.mdx", "content/**/*.mdx"]

这些文件在 next-ai-ready build 时被扫描，生成语义图谱、llms.txt 和逐页 Markdown/JSON。

actions

Action 模块路径，相对于配置文件解析：

js
actions: "./actions/index.mjs"

该模块应导出一个 defineActions(...) 包裹的 defineAction(...) 调用数组：

js
import { defineActions, defineAction } from "@next-ai-ready/actions";
export default defineActions([ ... ]);

emit

控制生成哪些产出物：

字段类型默认值描述
openapibooleantrue生成 /openapi.json、/tools.json、/ai-plugin.json