Astro integration to automatically generate AI-friendly documentation files: /llms.txt, /llms-small.txt, and /llms-full.txt
npm install astro-llms-generateMinimal LLMs TXT Generator for Astro Sites
Automatically discovers and processes all your Astro pages to generate three optimized documentation files:
- /llms.txt β Smart index with titles, descriptions, and organized links grouped by directory
- /llms-small.txt β Ultra-compact structure-only version (titles + URLs)
- /llms-full.txt β Complete Markdown content dump with full page content
---
``bash
pnpm i astro-llms-generate
npm i astro-llms-generate
yarn add astro-llms-generate
`
Or install directly with Astro:
`bash`
pnpm astro add astro-llms-generate
`javascript
import { defineConfig } from 'astro/config';
import astroLLMsGenerator from 'astro-llms-generate';
export default defineConfig({
site: 'https://example.com', // Required for full URLs in output files
integrations: [
astroLLMsGenerator(), // No configuration needed!
],
});
`
`javascript`
export default defineConfig({
site: 'https://example.com',
integrations: [
astroLLMsGenerator({
title: 'My Documentation',
description: 'Custom description for AI systems',
includePatterns: ['*/'], // Pages to include
excludePatterns: ['/404', '/api/*'], // Pages to exclude
customSeparator: '\n\n---\n\n' // Custom separator for full content
}),
],
});
Since files are generated in the build output, they're available at /llms.txt, /llms-small.txt, and /llms-full.txt in your deployed site. To include them in your sitemap:
`javascript
import sitemap from '@astrojs/sitemap';
export default defineConfig({
site: 'https://example.com',
integrations: [
astroLLMsGenerator(),
sitemap({
customPages: [
'https://example.com/llms.txt',
'https://example.com/llms-small.txt',
'https://example.com/llms-full.txt'
],
}),
],
});
`
Files are automatically generated in the build output directory during astro build:/llms.txt
- Available at , /llms-small.txt, /llms-full.txt in your final deploymentastro build
- Generated only when running (not during development)
- Build-time Generation: Runs during astro:build:done` for final deployment
- Memory Efficient: Uses smaller batch processing to prevent memory issues
- Parallel Processing: Generates all three files simultaneously
- Smart Cleanup: Properly disposes of JSDOM instances and triggers garbage collection
ps: forked from @4hse/astro-llms-txt for personal usage
Found a bug or want to contribute? Open an issue or submit a PR!