Get started
Prompts for Vibecoders
如果你用 Cursor、Claude Code、Codex 或其它 AI 编码助手开发,MinT 在固定 URL 暴露了一份 LLM 可读的整站文档摘要 —— 一次请求就能拿到全部上下文。
概念
llms.txt 是社区约定的格式,用于在文档站固定路径上提供 LLM 友好的内容摘要。MinT 直接从你读的同一份 MDX 自动生成这份文件,所以助手看到的内容和你完全一致 —— 不靠抓取,不会过期。
本站提供 3 个 URL:
| URL | 内容 |
|---|---|
/zh/llms.txt | 全部中文页的索引,每页一行简介 |
/zh/llms-full.txt | 全部中文页的完整 markdown 拼接 |
/zh/llms.mdx | 内容同 llms-full.txt,但以 MDX 形式提供(有的助手更喜欢 MDX 风格的 include) |
(英文版在 /en/llms.txt 等。)
模式
Cursor
在 Cursor 里把 URL 加到项目的 docs 上下文:
@docs https://mint-doc.macaron.im/zh/llms-full.txtCursor 会拉取文件并建索引,作为项目内每次提示的语义基础。MinT 发布更新后,重新拉一次即可同步。
Claude Code
在 Claude Code 会话开头让它拉一次:
读 https://mint-doc.macaron.im/zh/llms-full.txt 获取 MinT 完整文档,然后帮我在 Qwen3-30B 上写一个带自定义 reward 的 GRPO 训练循环。整个会话只需要拉一次;Claude Code 会把内容留在上下文里。
curl(冒烟测试)
在终端验证路由通:
curl -sL https://mint-doc.macaron.im/zh/llms.txt | head -40应该看到一串带文档 URL 的页标题列表。
API 接口
路由处理器在仓库的 app/[lang]/llms.txt/route.js。它走的是和侧边栏一样的 fumadocs page tree,剥掉只在 MDX 里有意义的组件(<Callout>、<WxImage>),输出纯 markdown。没有 query 参数;每次请求都从最新构建产物再生成。
注意事项
- Token 预算。 整站的
llms-full.txt有几千 token。绝大多数编码助手都装得下;如果只想喂某一页,把页面 URL 后面接上/content.md(例如/zh/community/customize/sft/content.md)—— fumadocs 会在这个路径下提供该页的 markdown 版本。 - 生效时间窗口。 路由读的是 build 产物,所以更新在站点重新部署时才落地(通常是公共
mint-doc仓库main分支合并后几分钟内)。如果你昨天写的页面还没出现,构建还在传播中。 - 路线图页面也会原样输出。 少数页面描述还在落地的能力(例如 VLM)。这些页面用清楚的语言说明状态;助手原样看到这些文本,不会凭空臆测一个已上线的功能。
- 不要把
MINT_API_KEY粘进 prompt。 文档里本来就没有真 key;但如果你从自己机器里复制脚本到 LLM prompt,先把sk-*token 擦掉再贴。
后续规划。 我们正在准备一个面向 Cursor / Claude Code 的 skill 包,封装 MinT 专用模式(RL 循环、自定义 reward、sampling)。进度跟踪在 mint-quickstart-alpha/mint-skill/SKILL.md。