ヘッドレスCMS向けllms.txt
ヘッドレスCMSプラットフォーム(Contentful、Sanity、Strapi、Directus)はファイルを直接配信しないため、CMSデータからビルド時にllms.txtを生成するか、サーバールートを介してリクエスト時に取得します。
最終更新:
ヘッドレスCMSではなく、ホスティング型のWebサイトビルダーを使用している場合は、専用ガイドを参照してください: Shopify, Webflow, Wix および Squarespace.
基本パターン:CMS API → ビルドステップ → 静的ファイル
ヘッドレス CMS
プラットフォームはコンテンツを管理しますが、任意のパスで任意のファイルを配信するものではありません。公開するには
llms.txtの場合、CMSからコンテンツを取得して自分でファイルを書き出す必要があります。次のいずれかの時点で行います:
ビルド時 (静的な出力)または リクエスト時 (サーバールート)。
- CMSを照会する、タイトル、slug、要約フィールドを持つ公開済みページを取得します。
- Markdown リンクにマッピング、各項目を次の形式にします:
- [Title](https://url/): description. - ファイルを書き込むか返します、次の場所に書き込みます:
public/llms.txtをビルド時に書き込むか、リクエスト時にサーバールートから返します。
Contentfulの例
以下の Contentful JavaScript SDK
Content Delivery API 経由でエントリを取得するため。このスクリプトはビルドステップ中に実行してください(例:
package.json スクリプトまたはCIパイプライン)で、フレームワークのビルド前に実行します。
// scripts/generate-llms-txt.mjs
// Contentful: fetch published doc entries and generate llms.txt at build time
import { createClient } from 'contentful';
import { writeFileSync } from 'fs';
const client = createClient({
space: process.env.CONTENTFUL_SPACE_ID,
accessToken: process.env.CONTENTFUL_ACCESS_TOKEN,
});
async function generateLlmsTxt() {
// Fetch entries of content type 'docPage' sorted by display order
const entries = await client.getEntries({
content_type: 'docPage',
order: 'fields.order',
select: 'fields.title,fields.slug,fields.summary',
limit: 100,
});
const SITE_URL = process.env.SITE_URL || 'https://yoursite.com';
const links = entries.items
.map((entry) => {
const { title, slug, summary } = entry.fields;
return `- [${title}](${SITE_URL}/docs/${slug}/): ${summary ?? ''}`;
})
.join('\n');
const content = [
'# Your Site',
'',
'> One-sentence description of your product.',
'',
'## Documentation',
'',
links,
'',
'## Optional',
'',
`- [Changelog](${SITE_URL}/changelog/): Release history.`,
].join('\n');
writeFileSync('public/llms.txt', content, 'utf-8');
console.log(`Generated llms.txt with ${entries.items.length} entries.`);
}
generateLlmsTxt().catch(console.error);
スクリプトをビルドパイプラインに追加します。
{
"scripts": {
"prebuild": "node scripts/generate-llms-txt.mjs",
"build": "next build"
}
} Sanityの例
Sanityのクエリ言語であるGROQを使用して、必要なフィールドのみを正確に取得してください。 !(_id in path("drafts.**")) filter により、公開済みのドキュメントのみが確実に含まれるようになります:
// scripts/generate-llms-txt.mjs
// Sanity: use GROQ to query published docs and generate llms.txt
import { createClient } from '@sanity/client';
import { writeFileSync } from 'fs';
const client = createClient({
projectId: process.env.SANITY_PROJECT_ID,
dataset: process.env.SANITY_DATASET || 'production',
useCdn: false, // always fetch fresh data at build time
apiVersion: '2024-01-01',
});
async function generateLlmsTxt() {
// GROQ query: fetch all published doc entries with title, slug, and summary
const docs = await client.fetch(
`*[_type == "doc" && !(_id in path("drafts.**"))] | order(order asc) {
title,
"slug": slug.current,
summary
}`
);
const SITE_URL = process.env.SITE_URL || 'https://yoursite.com';
const links = docs
.map((doc) => `- [${doc.title}](${SITE_URL}/docs/${doc.slug}/): ${doc.summary ?? ''}`)
.join('\n');
const content = [
'# Your Site',
'',
'> One-sentence description of your product.',
'',
'## Documentation',
'',
links,
].join('\n');
writeFileSync('public/llms.txt', content, 'utf-8');
console.log(`Generated llms.txt with ${docs.length} docs.`);
}
generateLlmsTxt().catch(console.error);
Strapiの例
Strapiは次の場所でREST APIを公開します: /api/:collection。次を使用します: fields および filters 必要なフィールドだけを含む公開済み文書を取得するためのクエリパラメーター:
// scripts/generate-llms-txt.mjs
// Strapi v4/v5: fetch published articles via REST API and generate llms.txt
import { writeFileSync } from 'fs';
const STRAPI_URL = process.env.STRAPI_URL || 'http://localhost:1337';
const STRAPI_TOKEN = process.env.STRAPI_API_TOKEN;
const SITE_URL = process.env.SITE_URL || 'https://yoursite.com';
async function generateLlmsTxt() {
// Fetch published docs, adjust the collection slug and fields as needed
const res = await fetch(
`${STRAPI_URL}/api/docs?fields[0]=title&fields[1]=slug&fields[2]=summary&filters[publishedAt][$notNull]=true&pagination[limit]=100`,
{
headers: STRAPI_TOKEN ? { Authorization: `Bearer ${STRAPI_TOKEN}` } : {},
}
);
if (!res.ok) throw new Error(`Strapi API error: ${res.status}`);
const { data } = await res.json();
const links = data
.map((item) => {
const { title, slug, summary } = item.attributes ?? item; // v4 vs v5
return `- [${title}](${SITE_URL}/docs/${slug}/): ${summary ?? ''}`;
})
.join('\n');
const content = [
'# Your Site',
'',
'> One-sentence description of your product.',
'',
'## Documentation',
'',
links,
].join('\n');
writeFileSync('public/llms.txt', content, 'utf-8');
console.log(`Generated llms.txt with ${data.length} entries.`);
}
generateLlmsTxt().catch(console.error);
Strapi v4 はレスポンスデータを attributes オブジェクト内にあります。Strapi v5はフィールドを最上位に返します。この例ではフォールバックを使って両方に対応しています。
Next.jsのルートハンドラーとの統合
完全な再構築を行わずにファイルを常に同期させたい場合は、Next.js App Routerのルート
ハンドラーを使用してください。 revalidate を希望するTTLに設定します。Next.jsはレスポンスをキャッシュし、
バックグラウンドで再生成します:
// app/llms.txt/route.ts
// Next.js App Router, fetch from CMS at request time (or cache with revalidate)
import { NextResponse } from 'next/server';
import { createClient } from 'contentful';
// Cache for 1 hour (Next.js incremental static regeneration)
export const revalidate = 3600;
const client = createClient({
space: process.env.CONTENTFUL_SPACE_ID!,
accessToken: process.env.CONTENTFUL_ACCESS_TOKEN!,
});
export async function GET() {
const entries = await client.getEntries({
content_type: 'docPage',
order: 'fields.order',
select: 'fields.title,fields.slug,fields.summary',
limit: 100,
});
const SITE_URL = process.env.NEXT_PUBLIC_SITE_URL || 'https://yoursite.com';
const links = entries.items
.map((e: any) => `- [${e.fields.title}](${SITE_URL}/docs/${e.fields.slug}/): ${e.fields.summary ?? ''}`)
.join('\n');
const body = [
'# Your Site',
'',
'> One-sentence description.',
'',
'## Documentation',
'',
links,
].join('\n');
return new NextResponse(body, {
headers: {
'Content-Type': 'text/plain; charset=utf-8',
'Cache-Control': 'public, max-age=3600, stale-while-revalidate=86400',
},
});
}
Astro エンドポイントとの統合
Astroでは、 src/pages/llms.txt.ts エンドポイントと export const prerender = true を使い、ビルド時にファイルを生成します。Astroは次の実行中にCMS
APIを呼び出します: astro build を実行し、静的ファイルを次へ書き込みます: dist/llms.txt:
// src/pages/llms.txt.ts
// Astro endpoint, fetch from CMS at build time (static generation)
import type { APIRoute } from 'astro';
import { createClient } from '@sanity/client';
// This endpoint is pre-rendered at build time
export const prerender = true;
const sanity = createClient({
projectId: import.meta.env.SANITY_PROJECT_ID,
dataset: import.meta.env.SANITY_DATASET || 'production',
useCdn: false,
apiVersion: '2024-01-01',
});
export const GET: APIRoute = async () => {
const docs = await sanity.fetch(
`*[_type == "doc" && !(_id in path("drafts.**"))] | order(order asc) {
title, "slug": slug.current, summary
}`
);
const SITE_URL = import.meta.env.SITE_URL || 'https://yoursite.com';
const links = docs
.map((doc: any) => `- [${doc.title}](${SITE_URL}/docs/${doc.slug}/): ${doc.summary ?? ''}`)
.join('\n');
const body = [
'# Your Site',
'',
'> One-sentence description of your product.',
'',
'## Documentation',
'',
links,
].join('\n');
return new Response(body, {
headers: { 'Content-Type': 'text/plain; charset=utf-8' },
});
};
静的生成と動的生成
- 静的(ビルド時)、より高速(CDN キャッシュ)、より簡単で、ランタイムの CMS 依存がありません。コンテンツの変更頻度が低い場合や、変更のたびにデプロイする場合に適しています。
- 動的(サーバールート)は常に最新のCMSコンテンツを反映します。デプロイの合間にコンテンツが頻繁に変わる場合や、コンテンツ変更時に再ビルドを起動できない場合に最適です。
Cache-Controlヘッダーを設定し、リクエストのたびに CMS APIへの過度な負荷を回避する。
チェックリスト
- スクリプトまたはエンドポイントによる取得のみ 公開済み コンテンツ(下書きではないもの)。
- 生成されたすべてのURLは 絶対URL (
https://). - ファイルがH1をちょうど1つだけ先頭に含むこと。
- H1の直後に引用ブロック形式の要約があること。
- 各セクションに少なくとも一つのリンクがある。
- ファイルが20 KB未満であること(すべての項目を流し込まず、厳選してください)。
-
ビルドステップがフレームワークのビルド前に実行される(
prebuildスクリプトまたはCIステップ)。 - 次で検証済み: llmtxt.info/validator/ (各デプロイ後)。
関連ガイド
- llms.txtの作成方法、テンプレートとデプロイガイド。
- Next.js ガイド、App Router、静的生成。
- Astroガイド、コンテンツコレクション、エンドポイント。
- llms.txt フォーマットリファレンス、仕様の詳細。
- バリデータ · ジェネレーター.