跳到主要内容

与 AI 协作

现在，您可以以更利于 LLM 的方式来使用 Android Macro 文档。

这为您提供了三种不同的访问方式：

  1. 在任意文档页面 URL 后添加 .md，即可将其作为纯 Markdown 打开
  2. 从 /llms.txt 加载精选的文档索引

Markdown 镜像​

每个文档路由现在都有对应的 Markdown 镜像。

示例：

  • HTML 页面：https://androidmacro.com/docs/basic/how-to-use
  • Markdown 页面：https://androidmacro.com/docs/basic/how-to-use.md

这在以下场景中非常有用：

  • 您想要将某个页面粘贴到 LLM 中
  • 您希望代理（agent）获取干净的文档版本，而不是解析 HTML
  • 您希望获得稳定的文本作为提示词上下文

llms.txt​

站点根目录公开了一个 llms.txt 索引：

https://androidmacro.com/llms.txt

此文件是专为 LLM 使用而整理的文档地图。它会优先将模型和工具引导至最重要的页面，然后链接到文档的 Markdown 版本。

相关文件：

  • https://androidmacro.com/llms-full.txt
  • https://androidmacro.com/llms-sitemap.txt

请按以下方式使用它们：

  • llms.txt 作为精选的起点
  • llms-full.txt 当您需要一次性导出整个文档语料库时
  • llms-sitemap.txt 当您需要机器友好的 Markdown URL 列表时

为什么这很有帮助​

HTML 文档是为人类设计的。LLM 通常在以下情况下表现更好：

  • 使用 Markdown 而非完整的页面 HTML
  • 使用精选的索引，而非盲目地抓取每个路由

因此，此设置同时采用了两种方式：

  • .md 镜像用于原始页面访问
  • llms.txt 风格的发现机制

当前架构​

Markdown 镜像和 llms.txt 文件会生成到 Docusaurus 的 static 输出目录中，因此它们会与文档站点一起部署。

说明​

  • 分类落地页也会生成 Markdown 镜像，例如 https://androidmacro.com/docs/reference/storage.md
  • 生成的 Markdown 是为 LLM 消费而设计的，因此一些交互式嵌入内容会被替换为简短说明
  • 内容变更后请重新构建文档站点，以确保 Markdown 镜像和 llms.txt 保持同步

相关页面​