Skip to main content
The llms.txt file is an industry standard that helps LLMs index content more efficiently, similar to how a sitemap helps search engines. AI tools can use this file to understand your documentation structure and find content relevant to user queries. Mintlify automatically hosts an llms.txt file at the root of your project that lists all available pages in your documentation. This file is always up to date and requires zero maintenance. You can optionally add a custom llms.txt file to the root of your project.
If your site requires authentication to access your documentation, your llms.txt and llms-full.txt files are not available to LLMs and AI tools. LLMs and AI tools can only index publicly available content.
View your llms.txt by appending /llms.txt to your documentation site’s URL. Open the llms.txt for this site.

​
llms.txt structure

An llms.txt file is a plain Markdown file that contains:
  • Site title as an H1 heading.
  • Structured content sections with links and a description of each page in your documentation.
  • API specification links to your OpenAPI and AsyncAPI specs, if your documentation includes them.
The llms.txt file lists your pages alphabetically in the order they appear in your repository, starting from the root directory. Each page’s description comes from the description field in its frontmatter. For API reference pages, the description also includes the specification information from the openapi or api frontmatter field. Pages without a description field appear in the llms.txt file without a description.
Example llms.txt
# Site title

## Docs

- [API](https://example.com/docs/api): Endpoint list and usage
- [Install](https://example.com/docs/install): Setup steps
- [Getting started](https://example.com/docs/start): Intro guide

## API specifications

- [openapi](https://example.com/docs/openapi.json)
- [asyncapi](https://example.com/docs/asyncapi.yaml)
This structured approach allows LLMs to efficiently process your documentation at a high level and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches.

​
llms-full.txt

The llms-full.txt file combines your entire documentation site into a single file as context for AI tools and LLM indexing. Mintlify automatically hosts an llms-full.txt file at the root of your project. View your llms-full.txt by appending /llms-full.txt to your documentation site’s URL. Open the llms-full.txt for this site.

​
Custom files

To add a custom llms.txt or llms-full.txt file, create an llms.txt or llms-full.txt file at the root of your project. Adding a custom file overrides the automatically generated file of the same name. If you delete a custom file, Mintlify restores the automatically generated file. Your custom llms.txt or llms-full.txt file must have a site title as an H1 heading. Other content is optional. See Format in the llms.txt specification for more information on optional sections and best practices.