llmtxt.info
简体中文
English Français Deutsch Español Italiano Русский العربية 日本語
验证文件

在 Astro 中使用 llms.txt

两种方法：将文件放入 public/ 以立即静态部署，或使用 TypeScript 端点根据内容集合动态生成。

最近更新:

方案 1，静态文件位于 public/

这是最简单的方案。在以下位置创建纯文本文件： public/llms.txt 放在项目根目录中。 Astro 会将整个 public/ 将目录原样复制到 dist/ 期间 astro build，因此该文件通过以下路径提供： /llms.txt ，无需任何配置。

static approach, public/llms.txt 
# Place the file at: public/llms.txt
# Astro copies everything in public/ to the output directory as-is.
# Result: served at https://yoursite.com/llms.txt, no code changes needed.

# After deploy, verify:
curl -I https://yoursite.com/llms.txt
# Expected: HTTP/2 200 | Content-Type: text/plain

何时使用这个： 您的内容不经常变化、您希望构建时零开销， 或者您手动维护该文件。它在 Cloudflare Pages、Vercel、Netlify 及任何其他 Astro 托管平台上的工作方式相同。

方案 2：使用以下功能的 TypeScript 端点： getCollection()

Astro 匹配双扩展名 .txt.ts 并将 src/pages/llms.txt.ts 作为一个 API 端点，响应地址为 /llms.txt. 在 SSG 模式（默认）下，Astro 会将其预渲染为静态 dist/llms.txt 在构建时生成，无运行时成本。

src/pages/llms.txt.ts 
// src/pages/llms.txt.ts
// Astro treats src/pages/foo.ext.ts as a route for /foo.ext
// In SSG mode (default), it pre-renders to dist/llms.txt at build time.

import type { APIRoute } from 'astro';
import { getCollection } from 'astro:content';

export const GET: APIRoute = async () => {
  // Replace 'docs' with your actual content collection name
  const docs = await getCollection('docs');

  const lines = [
    '# My Site',
    '',
    '> One-sentence description of what this site is about.',
    '',
    '## Documentation',
    '',
    ...docs
      .filter((d) => !d.data.draft)
      .sort((a, b) => (a.data.order ?? 999) - (b.data.order ?? 999))
      .map((d) => `- [${d.data.title}](https://yoursite.com/${d.slug}/): ${d.data.summary ?? ''}`.trimEnd()),
    '',
    '## Optional',
    '',
    '- [Changelog](https://yoursite.com/changelog/): version history.',
  ];

  return new Response(lines.join('\n'), {
    headers: { 'Content-Type': 'text/plain; charset=utf-8' },
  });
};

要点：

  • 替换 'docs' 替换为 src/content/config.ts.
  • 映射前过滤掉草稿： !d.data.draft.
  • 每行的注释（: short note) 是可选项，但强烈推荐，它 能为 LLM 提供每个页面的上下文，而无需它们先抓取页面。
  • 始终设置 Content-Type: text/plain; charset=utf-8 设置在响应中。

添加 llms-full.txt

该 llms-full.txt 配套文件会内联每个页面的完整正文， 适用于希望一次获取全部语料库的 RAG 流水线和 LLM 客户端。创建一个并行端点：

src/pages/llms-full.txt.ts 
// src/pages/llms-full.txt.ts
// Generates the full-content companion file.
// Each entry gets its full Markdown body inlined, useful for RAG pipelines.

import type { APIRoute } from 'astro';
import { getCollection } from 'astro:content';

export const GET: APIRoute = async () => {
  const docs = await getCollection('docs');
  const sections: string[] = [];

  for (const doc of docs.filter((d) => !d.data.draft)) {
    sections.push(
      `# ${doc.data.title}`,
      '',
      `URL: https://yoursite.com/${doc.slug}/`,
      '',
      doc.body,   // raw Markdown, no HTML, ideal for LLMs (Astro 4+)
      '',
      '---',
      '',
    );
  }

  return new Response(sections.join('\n'), {
    headers: { 'Content-Type': 'text/plain; charset=utf-8' },
  });
};

doc.body 包含原始 Markdown（Astro 4 起可用），非常适合 LLM：没有 HTML 标签，只有干净的语义文本。对于 Astro 3，请使用 render() 辅助工具，并用一个简单的正则去除标签。

构建后验证

verify 
# Build the project
npx astro build

# Check static output (works for both approaches in SSG mode)
cat dist/llms.txt

# Or start preview server and curl:
npx astro preview &
curl http://localhost:4321/llms.txt
curl http://localhost:4321/llms-full.txt

部署后，将线上 URL 粘贴到 验证器 以确认符合规范：恰好一个 H1、有效的链接语法 (- [title](https://...)），所有 URL 均为绝对地址，且没有空分节。

该选择哪种方式

  • 静态 public/llms.txt，最适合不经常更新的网站。 零开销，无需 TypeScript，适用于所有环境。
  • TypeScript 端点 src/pages/llms.txt.ts，最适合拥有大量自动生成页面的文档网站。每次构建时，文件都会自动保持同步，无需手动编辑。

→ 完整创建指南 · Next.js 指南 · WordPress 指南

来源