LLMs.txt
让 Claude、Cursor、Windsurf 等 AI 助手理解 HeroUI Native 文档
我们提供 LLMs.txt 文件,便于 AI 编程助手读取 HeroUI Native 文档。
可用文件
核心文档:
- /native/llms.txt — Native 文档快速索引
- /native/llms-full.txt — HeroUI Native 完整文档
上下文窗口较小时:
- /native/llms-components.txt — 仅组件文档
- /native/llms-patterns.txt — 常见模式与配方
全平台:
- /llms.txt — 快速索引(React + Native)
- /llms-full.txt — 完整文档(React + Native)
- /llms-components.txt — 全部组件文档
- /llms-patterns.txt — 全部模式与配方
接入方式
Claude Code: 让 Claude 引用文档,例如:
Use HeroUI Native documentation from https://heroui.com/native/llms.txt或在项目的 .claude 中配置以自动加载。
Cursor: 使用 @Docs:
@Docs https://heroui.com/native/llms-full.txtWindsurf: 写入 .windsurfrules:
#docs https://heroui.com/native/llms-full.txt其他 AI 工具: 多数助手支持通过 URL 引用文档,直接提供:
https://heroui.com/native/llms.txt仅组件文档:
https://heroui.com/native/llms-components.txt模式与最佳实践:
https://heroui.com/native/llms-patterns.txt参与改进
若 AI 生成代码有问题,欢迎在 GitHub 上协助改进 LLMs.txt 文件。