llms.txt
Auto-generate llms.txt and llms-full.txt files for AI-consumable documentation
zudo-doc can automatically generate llms.txt and llms-full.txt files, making your documentation easily consumable by AI tools and large language models.
Tip
The llms.txt standard is an emerging convention that helps AI tools discover and read your documentation. Many AI-powered tools already look for these files.
How It Works
When enabled, zudo-doc generates two files at build time:
/— An index listing all documentation pages with their titles, descriptions, and URLsllms. txt /— The full content of all documentation pages combined into a single filellms- full. txt
These files provide a machine-friendly view of your documentation that AI tools can consume without parsing HTML.
Enabling llms.txt
The feature is enabled by default. To explicitly control it, set llmsTxt in src/:
export const settings = {
// ...
llmsTxt: true, // enabled by default
};To disable it:
llmsTxt: false,Generated Output
llms.txt (Index)
The index file lists each documentation page with its title, description, and URL:
#llms-full.txt (Full Content)
The full content file includes the complete text of every documentation page, separated by headings:
# My Documentation
> Site description from settings
## Introduction
Welcome to the project...
## Configuration
The project is configured through...Page Exclusion
Pages with any of the following frontmatter fields are automatically excluded from both generated files:
draft: true— Draft pages excluded from buildunlisted: true— Built but hidden pagessearch_exclude: true— Pages excluded from search
---
title: Internal Notes
search_exclude: true
---Multi-Locale Support
When locales are configured, zudo-doc generates separate llms.txt files for each locale:
English (default):
/andllms. txt /llms- full. txt Japanese:
/andja/ llms. txt /ja/ llms- full. txt
Each locale's files contain only the pages from that locale's content directory. URLs in each file use the appropriate locale prefix.
HTML Discovery
When llmsTxt is enabled, zudo-doc adds <link> tags to the <head> of every page, helping AI tools discover the files even when the site is deployed at a subpath:
<link rel="alternate" type="text/plain" href="/my-docs/llms.txt" title="llms.txt" />
<link rel="alternate" type="text/plain" href="/my-docs/llms-full.txt" title="llms-full.txt" />This supplements the standard path-based discovery (/ at the domain root) which may not work when your site uses a base path like /.
Dev Mode
The generated files are available during development via zfb's devMiddleware. When running pnpm dev, requests to / and / are handled dynamically — no build step needed.
Tip
No need to build before testing. The llms.txt files work immediately with pnpm dev, just like search.
Production Build
During pnpm build, the files are written to the dist/ directory as static text files alongside the rest of your site.