llms.txt
llms.txt 是一种面向大语言模型（LLM）的文档规范文件，以 Markdown 格式提供组件库的完整 API 参考，使 AI 编码助手能够准确理解和使用 NacrDesign 组件。
什么是 llms.txt
llms.txt 是社区提议的一种标准，放置在网站根路径下，供 AI 工具自动检索项目文档。
核心价值
- AI 助手无需手动配置即可获取组件 API
- 结构化 Markdown 格式，LLM 解析率高
- 包含所有组件的 Props、Events、Slots、Methods
- 与文档站同步更新，始终保持最新
如何在 AI 工具中使用
主流 AI 编码工具都支持 llms.txt 规范，以下是几种常用方式：
Cursor / Claude Code
在项目根目录创建 .cursorrules 或 CLAUDE.md，添加：
当用户提到 NacrDesign 组件时，请先查阅 https://design.nacr.cn/llms.txt 获取最新 API 文档。
CodeBuddy
在工作区内直接引用 llms.txt 文件，AI 会自动读取组件 API。
ChatGPT / 通用 AI
在对话中粘贴 llms.txt 内容或提供 URL，让 AI 加载为上下文。
VS Code Copilot
在 .github/copilot-instructions.md 中引用 llms.txt URL。
文件内容结构
llms.txt 包含以下章节：
📦
安装与引入
nacr-design 模块安装、自动导入说明
📋
组件 API
85+ 组件的 Props、Events、Slots、Methods
🎨
CSS Variables
全局设计令牌和 CSS 自定义属性
托管配置
llms.txt 已通过 Nuxt 的 public 目录自动托管到站点根路径，无需额外配置。
实现方式
文件放置在 playground/public/llms.txt，Nuxt 会自动将其作为静态资源托管到 /llms.txt 路径。 部署后 AI 工具即可通过 https://design.nacr.cn/llms.txt 检索到完整的组件 API 文档。