Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ai/llmstxt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "llms.txt"
description: "Automatically generate llms.txt and llms-full.txt files so AI tools like ChatGPT and Claude can index and understand your documentation."

Check warning on line 3 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L3

Use 'LLMs?' instead of 'llms'.
keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"]
boost: 3
---
Expand All @@ -12,21 +12,25 @@
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.

<Note>
If your site requires authentication, `llms.txt` and `llms-full.txt` also require authentication to view. LLMs and AI tools that cannot authenticate into your site cannot access these files. The files exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).
Authentication changes how these files are served:

Check warning on line 15 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L15

In general, use active voice instead of passive voice ('are served').

- **Fully authenticated sites** (every page protected): `llms-full.txt` is not generated and returns a 404. `llms.txt` still lists pages but the linked pages require authentication.
- **Partially authenticated sites** (some public pages): `llms.txt` and `llms-full.txt` include only public pages. Pages behind authentication or assigned to [user groups](/deploy/authentication-setup#control-access-with-groups) are excluded, even for authenticated viewers.

Check warning on line 18 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L18

Use 'LLMs?' instead of 'llms'.

Check warning on line 18 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L18

In general, use active voice instead of passive voice ('are excluded').
- **Public sites**: Full support.

For more information on how authentication affects AI features, see [Feature availability](/deploy/authentication-setup#feature-availability).
</Note>

View your `llms.txt` by appending `/llms.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms.txt` for compatibility with tools that follow the `.well-known` convention.

<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site.</PreviewButton>

Check warning on line 26 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L26

Use 'LLMs?' instead of 'llms'.

Mintlify adds HTTP headers to every page response so AI tools can discover your `llms.txt` files without prior knowledge of their location:

- `Link: </llms.txt>; rel="llms-txt", </llms-full.txt>; rel="llms-full-txt"`: Follows the standard HTTP `Link` header format for resource discovery.

Check warning on line 30 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L30

Use 'LLMs?' instead of 'llms'.
- `X-Llms-Txt: /llms.txt`: A convenience header for tools that check for `llms.txt` support.

## llms.txt structure

Check warning on line 33 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L33

Use 'LLMs?' instead of 'llms'.

Check warning on line 33 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L33

'llms.txt structure' should use sentence-style capitalization.

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

Expand Down Expand Up @@ -67,7 +71,7 @@

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. Mintlify also hosts the file at `/.well-known/llms-full.txt` for compatibility with tools that follow the `.well-known` convention.

<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open the llms-full.txt for this site.</PreviewButton>

Check warning on line 74 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L74

Use 'LLMs?' instead of 'llms'.

## Custom files

Expand Down
2 changes: 1 addition & 1 deletion deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@
* **Scopes** (optional): Permissions to request. Copy the **entire** scope string (for example, for a scope like `provider.users.docs`, copy the complete `provider.users.docs`). Use multiple scopes if you need different access levels.
* **Additional authorization parameters** (optional): Additional query parameters to add to the initial authorization request.
* **Token URL**: Your OAuth token exchange endpoint.
* **Info API URL** (optional): Endpoint on your server that Mintlify calls to retrieve user info. Required for group-based access control. If omitted, the OAuth flow only verifies identity.

Check warning on line 107 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L107

Use 'endpoints?' instead of 'Endpoint'.
* **Logout URL** (optional): The native logout URL for your OAuth provider. When users log out, Mintlify validates the logout redirect against this configured URL for security. The redirect only succeeds if it exactly matches the configured `logoutUrl`. If you do not configure a logout URL, users redirect to `/login`. Mintlify redirects users with a `GET` request and does not append query parameters, so include any parameters (for example, `returnTo`) directly in the URL.

Check warning on line 108 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L108

Use 'logouts?' instead of 'Logout'.
* **Redirect URL** (optional): The URL to redirect users to after authentication.
5. Click **Save changes**.

Expand Down Expand Up @@ -137,7 +137,7 @@
- **Scopes**: `['provider.users.docs']`
- **Token URL**: `https://auth.foo.com/exchange`
- **Info API URL**: `https://api.foo.com/docs/user-info`
- **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs`

Check warning on line 140 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L140

Use 'logouts?' instead of 'Logout'.

**Create a user info endpoint** at `api.foo.com/docs/user-info`, which requires an OAuth access token with the `provider.users.docs` scope, and returns:

Expand Down Expand Up @@ -464,7 +464,7 @@

| Feature | Public | Fully authenticated (all pages protected) | Partially authenticated (some public pages) |
| :------ | :---------- | :---------------------------------- | :-------------------------------- |
| [llms.txt and llms-full.txt](/ai/llmstxt) | Full support | Available behind authentication, so AI tools may not be able to access the files | Available behind authentication, so AI tools may not be able to access the files |
| [llms.txt and llms-full.txt](/ai/llmstxt) | Full support | `llms-full.txt` is not available and returns a 404. `llms.txt` is served, but the pages it links to require authentication | Only public pages are included. Pages behind authentication or assigned to user groups are excluded, even for authenticated viewers |
| [MCP server](/ai/model-context-protocol) | Full support | Requires authentication to connect | Available without authentication for public pages and with authentication for protected pages |
| [Markdown export](/ai/markdown-export) | Full support | Full support, respects user groups | Full support, respects user groups |
| [PDF export](/optimize/pdf-exports) | Full support | Not supported | Not supported |
Expand Down
6 changes: 5 additions & 1 deletion es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ El [archivo llms.txt](https://llmstxt.org) es un estándar del sector que ayuda
Mintlify aloja automáticamente un archivo `llms.txt` en la raíz de tu proyecto que lista todas las páginas disponibles de tu documentación. Este archivo siempre está actualizado y no requiere mantenimiento. Opcionalmente, puedes añadir un `llms.txt` personalizado en la raíz de tu proyecto.

<Note>
Si tu sitio requiere autenticación, `llms.txt` y `llms-full.txt` también requieren autenticación para poder verse. Los LLM y las herramientas de IA que no puedan autenticarse en tu sitio no pueden acceder a estos archivos. Los archivos excluyen las páginas que pertenecen a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups).
La autenticación cambia cómo se sirven estos archivos:

- **Sitios totalmente autenticados** (todas las páginas protegidas): `llms-full.txt` no se genera y devuelve un 404. `llms.txt` sigue listando las páginas, pero las páginas enlazadas requieren autenticación.
- **Sitios parcialmente autenticados** (algunas páginas públicas): `llms.txt` y `llms-full.txt` solo incluyen páginas públicas. Las páginas detrás de autenticación o asignadas a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups) se excluyen, incluso para visitantes autenticados.
- **Sitios públicos**: Compatibilidad completa.

Para obtener más información sobre cómo la autenticación afecta las funciones de IA, consulta [Disponibilidad de funciones](/es/deploy/authentication-setup#feature-availability).
</Note>
Expand Down
4 changes: 2 additions & 2 deletions es/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuración de autenticación"
description: "Controla el acceso a tu documentación mediante la autenticación de usuarios."
description: "Configura la autenticación de usuarios en tu sitio de documentación con OAuth, JWT o enlaces compartidos para controlar el acceso a las páginas."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
---

Expand Down Expand Up @@ -496,7 +496,7 @@ Algunas funciones se comportan de manera diferente o no están disponibles cuand

| Función | Público | Totalmente autenticado (todas las páginas protegidas) | Parcialmente autenticado (algunas páginas públicas) |
| :----------------------------------------------------------- | :---------------------- | :--------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
| [llms.txt and llms-full.txt](/es/ai/llmstxt) | Compatibilidad completa | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder a los archivos | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder a los archivos |
| [llms.txt and llms-full.txt](/es/ai/llmstxt) | Compatibilidad completa | `llms-full.txt` no está disponible y devuelve un 404. `llms.txt` se sirve, pero las páginas enlazadas requieren autenticación | Solo se incluyen las páginas públicas. Las páginas detrás de autenticación o asignadas a grupos de usuarios se excluyen, incluso para visitantes autenticados |
| [Servidor MCP](/es/ai/model-context-protocol) | Compatibilidad completa | Requiere autenticación para conectarse | Disponible sin autenticación para páginas públicas y con autenticación para páginas protegidas |
| [Exportación a Markdown](/es/ai/markdown-export) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios |
| [Exportación a PDF](/es/optimize/pdf-exports) | Compatibilidad completa | No compatible | No compatible |
Expand Down
6 changes: 5 additions & 1 deletion fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ Le [fichier llms.txt](https://llmstxt.org) est une norme du secteur qui aide les
Mintlify héberge automatiquement, à la racine de votre projet, un fichier `llms.txt` qui répertorie toutes les pages disponibles de votre documentation. Ce fichier est toujours à jour et ne nécessite aucun entretien. Vous pouvez également ajouter un fichier `llms.txt` personnalisé à la racine de votre projet.

<Note>
Si votre site nécessite une authentification, `llms.txt` et `llms-full.txt` sont également soumis à une authentification pour être consultés. Les LLM et les outils d'IA qui ne peuvent pas s'authentifier sur votre site ne peuvent pas accéder à ces fichiers. Les fichiers excluent les pages qui appartiennent à des [groupes d'utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups).
L'authentification change la manière dont ces fichiers sont servis :

- **Sites entièrement authentifiés** (toutes les pages protégées) : `llms-full.txt` n'est pas généré et renvoie une 404. `llms.txt` continue de lister les pages, mais les pages liées nécessitent une authentification.
- **Sites partiellement authentifiés** (certaines pages publiques) : `llms.txt` et `llms-full.txt` n'incluent que les pages publiques. Les pages protégées par authentification ou assignées à des [groupes d'utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups) sont exclues, même pour les visiteurs authentifiés.
- **Sites publics** : Prise en charge complète.

Pour plus d'informations sur l'impact de l'authentification sur les fonctionnalités d'IA, voir [Disponibilité des fonctionnalités](/fr/deploy/authentication-setup#feature-availability).
</Note>
Expand Down
4 changes: 2 additions & 2 deletions fr/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration de l'authentification"
description: "Contrôlez l’accès à votre documentation en authentifiant les utilisateurs."
description: "Configurez l'authentification des utilisateurs pour votre site de documentation avec OAuth, JWT ou des liens partagés afin de contrôler l'accès aux pages."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
---

Expand Down Expand Up @@ -496,7 +496,7 @@ Certaines fonctionnalités se comportent différemment ou ne sont pas disponible

| Fonctionnalité | Public | Entièrement authentifié (toutes les pages protégées) | Partiellement authentifié (certaines pages publiques) |
| :------------------------------------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- |
| [llms.txt and llms-full.txt](/fr/ai/llmstxt) | Prise en charge complète | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès aux fichiers | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès aux fichiers |
| [llms.txt and llms-full.txt](/fr/ai/llmstxt) | Prise en charge complète | `llms-full.txt` n’est pas disponible et renvoie une 404. `llms.txt` est servi, mais les pages liées nécessitent une authentification | Seules les pages publiques sont incluses. Les pages protégées par authentification ou assignées à des groupes d’utilisateurs sont exclues, même pour les visiteurs authentifiés |
| [MCP server](/fr/ai/model-context-protocol) | Prise en charge complète | Nécessite une authentification pour se connecter | Disponible sans authentification pour les pages publiques et avec authentification pour les pages protégées |
| [Markdown export](/fr/ai/markdown-export) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs |
| [Export PDF](/fr/optimize/pdf-exports) | Prise en charge complète | Non pris en charge | Non pris en charge |
Expand Down
6 changes: 5 additions & 1 deletion zh/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"
Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件,列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以在项目根目录添加自定义的 `llms.txt` 文件。

<Note>
如果你的站点需要认证,查看 `llms.txt` 和 `llms-full.txt` 也同样需要认证。无法通过你站点认证的 LLM 和 AI 工具将无法访问这些文件。这些文件会排除属于[用户分组](/zh/deploy/authentication-setup#control-access-with-groups)的页面。
认证会改变这些文件的提供方式:

- **完全需要认证的站点**(所有页面均受保护):不会生成 `llms-full.txt`,访问时返回 404。`llms.txt` 仍会列出页面,但其链接的页面需要认证才能访问。
- **部分需要认证的站点**(部分页面公开):`llms.txt` 和 `llms-full.txt` 仅包含公开页面。需要认证的页面或分配给[用户分组](/zh/deploy/authentication-setup#control-access-with-groups)的页面会被排除,即使对已认证的访问者也是如此。
- **公开站点**:完全支持。

有关认证如何影响 AI 功能的更多信息,请参阅[功能可用性](/zh/deploy/authentication-setup#feature-availability)。
</Note>
Expand Down
2 changes: 1 addition & 1 deletion zh/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ groups: ["admin"]

| 功能 | 公开 | 完全认证 (所有页面受保护) | 部分认证 (部分页面公开) |
| :------------------------------------------------------- | :--- | :----------------------------- | :----------------------------- |
| [llms.txt 和 llms-full.txt](/zh/ai/llmstxt) | 完全支持 | 需要通过认证后才能访问,因此 AI 工具可能无法访问这些文件 | 需要通过认证后才能访问,因此 AI 工具可能无法访问这些文件 |
| [llms.txt 和 llms-full.txt](/zh/ai/llmstxt) | 完全支持 | `llms-full.txt` 不可用,访问时返回 404。`llms.txt` 可访问,但其链接的页面需要认证 | 仅包含公开页面。需要认证的页面或分配给用户分组的页面会被排除,即使对已认证的访问者也是如此 |
| [MCP 服务器](/zh/ai/model-context-protocol) | 完全支持 | 连接时需要认证 | 公开页面无需认证即可使用,受保护页面则需要认证 |
| [Markdown 导出](/zh/ai/markdown-export) | 完全支持 | 完全支持,尊重用户分组 | 完全支持,尊重用户分组 |
| [PDF 导出](/zh/optimize/pdf-exports) | 完全支持 | 不支持 | 不支持 |
Expand Down
Loading