You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
10
10
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.
12
12
13
13
View your `llms.txt` by appending `/llms.txt` to your documentation site's URL.
14
14
15
-
<PreviewButtonhref="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
+
<PreviewButtonhref="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site.</PreviewButton>
18
16
19
17
## llms.txt structure
20
18
21
19
An `llms.txt` file is a plain Markdown file that contains:
22
20
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.
25
23
26
24
```mdx Example llms.txt
27
25
# Example product docs
@@ -34,14 +32,18 @@ An `llms.txt` file is a plain Markdown file that contains:
34
32
-[API](https://example.com/docs/api): Endpoint list and usage
35
33
```
36
34
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.
38
36
39
37
## llms-full.txt
40
38
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.
42
40
43
41
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.
44
42
45
-
<PreviewButtonhref="https://mintlify.com/docs/llms-full.txt">Open the llms-full.txt for this site</PreviewButton>
43
+
<PreviewButtonhref="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.
46
48
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.
Copy file name to clipboardExpand all lines: settings/seo.mdx
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,9 +138,9 @@ You can preview how your meta tags will appear on different platforms using [met
138
138
}
139
139
```
140
140
141
-
## Sitemaps
141
+
## Sitemaps and robots.txt files
142
142
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.
144
144
145
145
Only pages included in your `docs.json` are included by default. To include hidden links, add `seo.indexing` to your `docs.json`:
146
146
@@ -150,6 +150,10 @@ Only pages included in your `docs.json` are included by default. To include hidd
150
150
}
151
151
```
152
152
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
+
153
157
## Disabling indexing
154
158
155
159
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