starlight-llms-txt/llms-custom.txt.ts

Generate llms.txt files to train large language models on your Starlight documentation website

import type {
	APIRoute,
	GetStaticPaths,
	InferGetStaticParamsType,
	InferGetStaticPropsType,
} from 'astro';
import { starlightLllmsTxtContext } from 'virtual:starlight-llms-txt/context';
import { generateLlmsTxt } from './generator';

// Explicitly set this to prerender so it works the same way for sites in `server` mode.
export const prerender = true;

export const getStaticPaths = (() => {
	return starlightLllmsTxtContext.customSets.map(({ label, description, paths, slug }) => ({
		params: { slug },
		props: { label, description, paths },
	}));
}) satisfies GetStaticPaths;

type Props = InferGetStaticPropsType<typeof getStaticPaths>;
type Params = InferGetStaticParamsType<typeof getStaticPaths>;

/**
 * Route that generates a single plaintext Markdown document from the full website content.
 */
export const GET: APIRoute<Props, Params> = async (context) => {
	let description = context.props.label;
	if (context.props.description) description += ': ' + context.props.description;
	const body = await generateLlmsTxt(context, {
		minify: true,
		description,
		include: context.props.paths,
	});
	return new Response(body);
};