llms.txt

View source
文档站自动生成 llms.txt 与 llms-full.txt,为大模型提供结构化的库能力与文档索引。

什么是 llms.txt?

llms.txt 是一种面向大语言模型(LLM)的结构化文档格式。文档站经内置 nuxt-llms 自动生成 llms.txt 文件,包含本组件库的结构化信息,便于 AI 工具理解并协助 @movk/mapbox 开发。

这些文件为 AI 消费而优化,涵盖组件、API、用法模式与最佳实践,默认启用、无需手动维护。

可用路由

文档站提供以下 llms.txt 路由:

  • /llms.txt:全部内容的结构化概览与文档链接(约 5K tokens)
  • /llms-full.txt:完整文档,含实现细节、示例、类型定义与最佳实践(体量大)

选择正确的文件

多数场景从 /llms.txt 开始即可——它包含全部核心信息,适配标准 LLM 上下文窗口。仅当需要完整实现示例且 AI 工具支持大上下文(200K+ tokens)时,再用 /llms-full.txt

重要使用说明

使用 Cursor 或 Windsurf 等工具时,@ 符号必须在聊天框内手动输入;复制粘贴会破坏工具对上下文引用的识别。

在 AI 工具中使用

Cursor

可在 Cursor 中引用 llms.txt 文件以获得更好的 AI 辅助:

  1. 直接引用:提问时提及 llms.txt URL
  2. @docs 将上述 URL 加入项目上下文

Windsurf

Windsurf 可直接访问 llms.txt 文件以理解组件用法与最佳实践:

  • @docs 引用具体 llms.txt URL
  • 在工作区创建引用这些 URL 的持久规则

其他 AI 工具

任何支持 llms.txt 的 AI 工具都可用这些路由更好地理解本库。面向 ChatGPT、Claude 等的提示示例:

  • 「使用 Movk Mapbox 文档 https://mapbox.mhaibaraai.cn/llms.txt
  • 「遵循完整指南 https://mapbox.mhaibaraai.cn/llms-full.txt
llms.txt 告诉 AI「去哪里找信息」,Agent Skills 告诉 AI「能做什么、怎么做」,两者配合效果最佳。
Copyright © 2026 - 2026 YiXuan - MIT License