文档贡献者
本指南介绍如何让 AI 工具更好地理解 Ant Design。
我们支持通过 LLMs.txt 文件向大语言模型(LLMs)提供 Ant Design 文档。此功能可帮助 AI 工具更好地理解我们的组件库、API 及使用模式。
我们提供多个聚合文件来帮助 AI 工具访问文档:
| 文件 | 说明 |
|---|---|
| llms.txt | 导航文件,包含所有文档和组件的链接 |
| llms-full.txt | 完整的组件文档(英文),包含实现细节和示例 |
| llms-full-cn.txt | 完整的组件文档(中文) |
| llms-semantic.md | 组件语义描述(英文),包含 DOM 结构和使用模式 |
| llms-semantic-cn.md | 组件语义描述(中文) |
通过 .md 后缀直接访问单个组件文档:
https://ant.design/components/button.md(英文)https://ant.design/components/button-cn.md(中文)每个组件都有对应的语义描述文件:
https://ant.design/components/button/semantic.md(英文)https://ant.design/components/button-cn/semantic.md(中文)语义文档包含:
| 工具 | 说明 | 提示词 |
|---|---|---|
| Cursor | 使用 @Docs 功能引入 LLMs.txt,或添加提示词到 .cursor/rules。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Windsurf | 添加提示词到 .windsurf/rules 或使用 cascade memories。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Claude Code | 添加到 CLAUDE.md 或使用 /memory 持久化。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Codex | 添加到 .codex/settings.json 或 AGENTS.md。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Gemini CLI | 使用 --context 参数或添加到 .gemini/config.json。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Trae | 添加到项目的知识源设置中。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Qoder | 添加到 .qoder/config.yml 或在对话中使用 @docs。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |
| Neovate Code | 运行 neovate 并使用提示词描述任务。文档 | 阅读 https://ant.design/llms-full.txt 并理解 Ant Design 组件库,在编写 Ant Design 代码时使用这些知识。 |