Back to Ant Design

LLMs.txt

docs/react/llms.en-US.md

6.3.74.3 KB
Original Source

This guide explains how to enable AI tools to better understand Ant Design.

What is LLMs.txt?

We support LLMs.txt files for making the Ant Design documentation available to large language models (LLMs). This feature helps AI tools better understand our component library, its APIs, and usage patterns.

Available Resources

LLMs.txt Aggregated Files

We provide several aggregated files to help AI tools access our documentation:

FileDescription
llms.txtNavigation file with links to all documentation and components
llms-full.txtComplete component documentation (English) with implementation details and examples
llms-full-cn.txtComplete component documentation (Chinese)
llms-semantic.mdSemantic component descriptions (English) with DOM structure and usage patterns
llms-semantic-cn.mdSemantic component descriptions (Chinese)

Single Component Documentation

Add .md suffix to the original component documentation URL:

Semantic Documentation

Each component has a semantic description file:

Semantic documentation includes:

  • Component parts and their purposes
  • Usage examples and best practices
  • DOM structure overview

Usage with AI Tools

ToolDescriptionPrompt
CursorUse @Docs feature to include LLMs.txt, or add prompt to .cursor/rules. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
WindsurfAdd prompt to .windsurf/rules or use cascade memories. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
Claude CodeAdd to CLAUDE.md or use /memory to persist. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
CodexAdd to .codex/settings.json or AGENTS.md. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
Gemini CLIUse --context parameter or add to .gemini/config.json. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
TraeAdd to project's knowledge sources in settings. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
QoderAdd to .qoder/config.yml or use @docs in conversation. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
Neovate CodeRun neovate and describe task with prompt. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.
Qwen CodeOpen-source terminal AI agent with free OAuth tier. Run qwen for interactive mode, use @ to reference files. DocumentationRead https://ant.design/llms-full.txt and understand Ant Design components. Use this knowledge when writing code with Ant Design.