# AI 阅读

> 通过 llms.txt 索引、独立 Markdown 与完整文档，让 AI 助手读取 UI Docs 的组件参数、代码示例和使用限制，并回到原始页面查看预览。

原始页面：[AI 阅读](http://docs.quyongqing.cn/ai.html)

UI Docs 提供纯 Markdown 版本，方便 AI 助手读取组件 API 和示例，也适合下载后在编辑器中查阅。参数表、暴露方法与折叠代码都包含在文档中，交互预览请在原始网页查看。

## 选择阅读入口

-   [文档索引 llms.txt](http://docs.quyongqing.cn/llms.txt)：按组件与项目列出文档和摘要，适合先定位相关内容。
-   [完整文档 llms-full.txt](http://docs.quyongqing.cn/llms-full.txt)：合并本站所有导出的正文，适合需要同时参考多个组件的场景。
-   [下载 QyqForm Markdown](http://docs.quyongqing.cn/components/qyq-form.md)：只读取动态表单的说明、参数和示例。
-   [下载预计进度条 Markdown](http://docs.quyongqing.cn/components/estimated-progress-bar.md)：只读取模拟进度、完成和失败处理的说明。

需要其他组件时，可从索引中选择对应 Markdown。每篇文档都附有原始页面链接，便于检查交互效果和引用来源。

## 在 AI 助手中使用

将所需文档的完整链接粘贴给支持网页读取的 AI 助手，再描述你的业务场景。例如，附上 QyqForm 文档地址后可以这样提问：

> 请根据这篇文档，用 QyqForm 编写一个包含关键词和状态筛选的 Vue 3 示例。说明所需依赖，以及查询、重置时由调用方处理的逻辑。

如果助手无法访问链接，可以把下载后的 Markdown 文件作为上下文提供。优先选取相关组件文档，有跨组件需求时再使用完整文档。

## 使用前核对

-   本仓库提供组件源码接入方式，具体依赖与导入路径见各组件文档。
-   AI 生成的代码仍需结合项目中的组件版本和业务接口进行检查。
-   标注为“模板片段”的示例需要配合实际数据和事件处理，不能直接作为完整页面运行。
-   涉及错误、取消、校验或重置时，参考对应文档的限制说明。

还可以浏览[组件目录](http://docs.quyongqing.cn/components/)和[项目专题](http://docs.quyongqing.cn/projects/)，按场景选择资料。