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
4 changes: 3 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,23 @@
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).
If your site is fully authenticated, `llms.txt` and `llms-full.txt` require authentication to view, so LLMs and AI tools that cannot sign in cannot access these files.

If your site is partially authenticated, `llms.txt` requires authentication, but `llms-full.txt` is publicly accessible and automatically excludes pages that require authentication or belong to [user groups](/deploy/authentication-setup#control-access-with-groups). This lets AI tools index your public content without signing in while keeping protected pages private.

Check warning on line 17 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L17

Use 'LLMs?' instead of 'llms'.

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 24 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L24

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 28 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L28

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 31 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L31

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

Check warning on line 31 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L31

Use 'LLMs?' instead of 'llms'.

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

Expand Down Expand Up @@ -67,7 +69,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 72 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L72

Use 'LLMs?' instead of 'llms'.

## Custom files

Expand Down
5 changes: 3 additions & 2 deletions 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 @@ -460,11 +460,12 @@

## Feature availability

Some features behave differently or are unavailable when you enable authentication. Mintlify does not support serving arbitrary files publicly on an authenticated site. All hosted files, including `llms.txt`, `llms-full.txt`, and `skill.md`, are subject to the same authentication requirements as your documentation pages.
Some features behave differently or are unavailable when you enable authentication. Mintlify does not support serving arbitrary files publicly on an authenticated site. Hosted files like `llms.txt` and `skill.md` are subject to the same authentication requirements as your documentation pages. `llms-full.txt`, `sitemap.xml`, and `robots.txt` remain publicly accessible on partially authenticated sites and exclude pages that require authentication.

| 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](/ai/llmstxt) | Full support | Available behind authentication, so AI tools may not be able to access the file | Available behind authentication, so AI tools may not be able to access the file |
| [llms-full.txt](/ai/llmstxt#llms-fulltxt) | Full support | Available behind authentication, so AI tools may not be able to access the file | Available without authentication, excludes pages in groups and pages that require authentication |
| [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
4 changes: 3 additions & 1 deletion es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ 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).
Si tu sitio está totalmente autenticado, `llms.txt` y `llms-full.txt` requieren autenticación para poder verse, por lo que los LLM y las herramientas de IA que no puedan iniciar sesión no pueden acceder a estos archivos.

Si tu sitio está parcialmente autenticado, `llms.txt` requiere autenticación, pero `llms-full.txt` es de acceso público y excluye automáticamente las páginas que requieren autenticación o pertenecen a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups). Esto permite que las herramientas de IA indexen tu contenido público sin iniciar sesión y, al mismo tiempo, mantiene privadas las páginas protegidas.

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
5 changes: 3 additions & 2 deletions es/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -492,11 +492,12 @@ Cuando utilices autenticación OAuth o JWT, tu sistema devolverá datos de usuar
## Disponibilidad de funciones
</div>

Algunas funciones se comportan de manera diferente o no están disponibles cuando habilitas la autenticación. Mintlify no admite el alojamiento público de archivos arbitrarios en un sitio autenticado. Todos los archivos alojados, incluidos `llms.txt`, `llms-full.txt` y `skill.md`, están sujetos a los mismos requisitos de autenticación que las páginas de tu documentación.
Algunas funciones se comportan de manera diferente o no están disponibles cuando habilitas la autenticación. Mintlify no admite el alojamiento público de archivos arbitrarios en un sitio autenticado. Los archivos alojados como `llms.txt` y `skill.md` están sujetos a los mismos requisitos de autenticación que las páginas de tu documentación. `llms-full.txt`, `sitemap.xml` y `robots.txt` siguen siendo de acceso público en sitios parcialmente autenticados y excluyen las páginas que requieren autenticación.

| 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](/es/ai/llmstxt) | Compatibilidad completa | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder al archivo | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder al archivo |
| [llms-full.txt](/es/ai/llmstxt#llms-fulltxt) | Compatibilidad completa | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder al archivo | Disponible sin autenticación, excluye las páginas en grupos y las páginas que requieren autenticación |
| [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
4 changes: 3 additions & 1 deletion fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ 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).
Si votre site est entièrement authentifié, `llms.txt` et `llms-full.txt` nécessitent une authentification pour être consultés. Les LLM et les outils d'IA qui ne peuvent pas se connecter ne peuvent pas accéder à ces fichiers.

Si votre site est partiellement authentifié, `llms.txt` nécessite une authentification, mais `llms-full.txt` est accessible publiquement et exclut automatiquement les pages qui nécessitent une authentification ou appartiennent à des [groupes d'utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups). Cela permet aux outils d'IA d'indexer votre contenu public sans se connecter, tout en gardant les pages protégées privées.

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
5 changes: 3 additions & 2 deletions fr/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -492,11 +492,12 @@ Lorsque vous utilisez l’authentification OAuth ou JWT, votre système renvoie
## Disponibilité des fonctionnalités
</div>

Certaines fonctionnalités se comportent différemment ou ne sont pas disponibles lorsque vous activez l’authentification. Mintlify ne prend pas en charge l’hébergement de fichiers publics arbitraires sur un site authentifié. Tous les fichiers hébergés, y compris `llms.txt`, `llms-full.txt` et `skill.md`, sont soumis aux mêmes exigences d’authentification que vos pages de documentation.
Certaines fonctionnalités se comportent différemment ou ne sont pas disponibles lorsque vous activez l’authentification. Mintlify ne prend pas en charge l’hébergement de fichiers publics arbitraires sur un site authentifié. Les fichiers hébergés comme `llms.txt` et `skill.md` sont soumis aux mêmes exigences d’authentification que vos pages de documentation. `llms-full.txt`, `sitemap.xml` et `robots.txt` restent accessibles publiquement sur les sites partiellement authentifiés et excluent les pages qui nécessitent une authentification.

| 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](/fr/ai/llmstxt) | Prise en charge complète | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès au fichier | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès au fichier |
| [llms-full.txt](/fr/ai/llmstxt#llms-fulltxt) | Prise en charge complète | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès au fichier | Disponible sans authentification, exclut les pages dans des groupes et les pages qui nécessitent une authentification |
| [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
Loading