Skip to content

Commit 483ceda

Browse files
authored
Docs for custom generated files (#994)
* add info on custom `llms.txt` files * add llms-full.txt * add sitemap and robots.txt * Update llmstxt.mdx
1 parent 1984413 commit 483ceda

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

ai/llmstxt.mdx

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,20 @@ icon: "file-code"
66

77
import { PreviewButton } from "/snippets/previewbutton.jsx"
88

9-
The [llms.txt file](https://llmstxt.org) is an industry standard that helps LLMs index content more efficiently, similar to how a sitemap helps search engines.
9+
The [llms.txt file](https://llmstxt.org) 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.
1010

11-
Mintlify automatically hosts an `llms.txt` file at the root of your project that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.
11+
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.
1212

1313
View your `llms.txt` by appending `/llms.txt` to your documentation site's URL.
1414

15-
<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site</PreviewButton>
16-
17-
Your site's `llms.txt` is always up to date and requires zero maintenance.
15+
<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site.</PreviewButton>
1816

1917
## llms.txt structure
2018

2119
An `llms.txt` file is a plain Markdown file that contains:
2220

23-
- **Site title** as an H1 heading. This is the only required section of an `llms.txt`.
24-
- **Structured content sections** with descriptive links to key pages.
21+
- **Site title** as an H1 heading.
22+
- **Structured content sections** with links and a description of each page in your documentation.
2523

2624
```mdx Example llms.txt
2725
# Example product docs
@@ -34,14 +32,18 @@ An `llms.txt` file is a plain Markdown file that contains:
3432
- [API](https://example.com/docs/api): Endpoint list and usage
3533
```
3634

37-
This structured approach allows LLMs to quickly process your documentation hierarchy and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches.
35+
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.
3836

3937
## llms-full.txt
4038

41-
The `llms-full.txt` file combines your entire documentation site into a single file as context for AI tools and is indexed by LLM traffic. Users can paste a single URL as context for AI tools for more relevant and accurate responses.
39+
The `llms-full.txt` file combines your entire documentation site into a single file as context for AI tools and is indexed by LLM traffic.
4240

4341
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.
4442

45-
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open the llms-full.txt for this site</PreviewButton>
43+
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open the llms-full.txt for this site.</PreviewButton>
44+
45+
## Custom files
46+
47+
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 will override the automatically generated file of the same name. If you delete a custom file, the default file will be used again.
4648

47-
Your site's `llms-full.txt` is always up to date and requires zero maintenance.
49+
Your custom `llms.txt` or `llms-full.txt` file must have a site title as an H1 heading. Other content is optional. See [Format](https://llmstxt.org/#format) in the `llms.txt` specification for more information on optional sections and best practices.

settings/seo.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ You can preview how your meta tags will appear on different platforms using [met
138138
}
139139
```
140140

141-
## Sitemaps
141+
## Sitemaps and robots.txt files
142142

143-
Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. Simply navigate to `/sitemap.xml` to see your sitemap.
143+
Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. You can view your sitemap by appending `/sitemap.xml` to your documentation site's URL.
144144

145145
Only pages included in your `docs.json` are included by default. To include hidden links, add `seo.indexing` to your `docs.json`:
146146

@@ -150,6 +150,10 @@ Only pages included in your `docs.json` are included by default. To include hidd
150150
}
151151
```
152152

153+
### Custom sitemaps and robots.txt files
154+
155+
To add a custom `sitemap.xml` or `robots.txt` file, create a `sitemap.xml` or `robots.txt` file at the root of your project. Adding a custom file will override the automatically generated file of the same name. If you delete a custom file, the default file will be used again.
156+
153157
## Disabling indexing
154158

155159
If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](pages) of your page:

0 commit comments

Comments
 (0)