llms.txt
The .llms.txt feature allows your documentation site to expose a structured, machine-readable index that helps large language models (LLMs) discover and understand your content more efficiently.
What Is .llms.txt?
.llms.txt is a plain-text file that provides a structured summary of your documentation, including:
- The title and description of each section
- Direct links to the corresponding Markdown (
.md) source files - A hierarchical overview of your content structure
This allows AI tools, developer assistants, and LLM-powered integrations to index your documentation accurately - without needing to crawl or parse your full rendered HTML site.
How It Works
Theneo generates your .llms.txt file automatically using the SEO management data you have already configured for each page in your documentation. No additional setup is required for content that already has SEO fields filled in.
The file is built from the following existing fields:
Field | Description |
Title | The section title used in search engine metadata |
Description | The SEO meta description for the page |
Slug | The URL path segment used to construct the page link |
Each entry in the .llms.txt file maps one documentation page to its title, a short description, and the direct link to its Markdown source file.
File Format
The generated .llms.txt file follows the standard format below:
# <Site Title>
> <Site-level description>
## <Section Name>
- [<Page Title>](<link-to-.md-file>): <Page description>
- [<Page Title>](<link-to-.md-file>): <Page description>
## <Section Name>
- [<Page Title>](<link-to-.md-file>): <Page description>Managing SEO Data for Better Coverage
Since .llms.txt is generated from your existing SEO fields, the quality of your index depends on how thoroughly those fields are filled in. To ensure complete and accurate coverage:
- Title: Keep titles concise and descriptive. Avoid generic labels like "Overview" when a more specific title such as "Authentication Overview" is more informative.
- Description: Write descriptions that summarize what the page covers in one to two sentences. This text appears directly in the
.llms.txtfile and is what LLMs will use to understand the page's purpose. - Slug: Use clean, readable slugs that reflect the page hierarchy (e.g.,
/guides/authenticationrather than/page-42).
To review or update SEO data for a page:
- From the project dashboard, navigate to SEO Management.
- Edit the Title, Description, and Slug fields as needed.
- Click Save Changes.
Verifying Your .llms.txt File
You can verify the file is live and correctly formatted by visiting your documentation URL directly in a browser or using a tool such as curl:
curl https://app.theneo.io/theneo/quickstart/llms.txtCheck the following:
- All major sections of your documentation are represented.
- Each entry includes a title, a valid link to a
.mdfile, and a description. - The file is accessible without authentication (it must be publicly reachable to be useful to external LLM systems).
Frequently Asked Questions
Which pages are included in the file?
Which pages are included in the file?
All published pages with SEO metadata (title, description, and slug) are included. Draft pages and unpublished content are excluded automatically.
How often is the file updated?
How often is the file updated?
The file regenerates each time you publish a change to your documentation. There is no manual refresh required.
What happens if a page is missing a description?
What happens if a page is missing a description?
Pages without a description will still appear in the file but the description field will be left blank. It is recommended to fill in descriptions for all pages to maximize usefulness to LLM consumers.
Will header sections be automatically excluded from .llms.txt?
Will header sections be automatically excluded from .llms.txt?
Yes. Header sections - sections that serve as labels or groupings in your navigation without content of their own - are automatically excluded from the generated .llms.txt file.
What made this section unhelpful for you?
On this page
- llms.txt