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
9 changes: 9 additions & 0 deletions ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
- `X-Llms-Txt`: A convenience header for tools that check for `llms.txt` support.

```http Response headers
Link: </llms.txt>; rel="llms-txt", </llms-full.txt>; rel="llms-full-txt", </.well-known/api-catalog>; rel="api-catalog", </.well-known/mcp/server-card.json>; rel="mcp-server-card", </.well-known/agent-card.json>; rel="agent-card", </.well-known/agent-skills/index.json>; rel="agent-skills"

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 'API' instead of 'api'.
X-Llms-Txt: /llms.txt
```

Expand Down Expand Up @@ -69,14 +69,14 @@
- [API reference (250 pages)](https://docs.example.com/_llms/api-reference.md): Endpoint documentation for the example API
```

A generated index can link to further indexes. For example, `/_llms/api-reference.md` can link to `/_llms/api-reference/admin.md` when a group is too large for a single file. Agents should follow these index links recursively until they reach documentation page links. Mintlify may shorten page descriptions in a split index to keep each file under the character limit.

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 'API' instead of 'api'.

The generated files are part of `llms.txt` and do not need to exist in your repository. They are separate from `llms-full.txt`.

The `/_llms/` route uses the same base path as your documentation:

- A root-hosted site serves an index at `https://docs.example.com/_llms/api-reference.md`.
- A site hosted at `/docs` serves it at `https://example.com/docs/_llms/api-reference.md`.

Check warning on line 79 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L79

Use 'API' instead of 'api'.

If you use a reverse proxy or path allowlist, forward the generated route in addition to `llms.txt`. A broad `<base-path>/*` rule already includes `<base-path>/_llms/*`. With granular rules, add `<base-path>/_llms/*` explicitly. See [Reverse proxy](/deploy/reverse-proxy#routing-configuration) for routing guidance.

Expand Down Expand Up @@ -121,3 +121,12 @@
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](https://llmstxt.org/#format) in the `llms.txt` specification for more information on optional sections and best practices.

### Custom files on authenticated sites

On sites with [authentication](/deploy/authentication-setup) enabled, Mintlify checks the pages that your custom file links to or embeds each time your site updates:

- If every linked page is public, Mintlify serves your custom file to all visitors, including AI tools that cannot authenticate.
- If any linked page requires authentication or is restricted to user groups, Mintlify serves your custom file only to authenticated users. Anonymous visitors receive the automatically generated file instead.

Check warning on line 130 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L130

In general, use active voice instead of passive voice ('is restricted').

If anonymous visitors see the generated file instead of your custom file, see [Fix a custom llms.txt that anonymous visitors cannot see](/help-center/custom-llms-txt-shows-generated-index).
2 changes: 1 addition & 1 deletion deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@
</ParamField>

<ParamField path="apiPlaygroundInputs" type="object">
Prefills API playground fields with user-specific values. When a user authenticates, these values populate the corresponding input fields in the API playground. Users can override prefilled values, and their overrides persist in local storage.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L483

Use 'prefill(s|ing|ed)?' instead of 'Prefills'.

Mintlify applies only values that match the current endpoint's security scheme.

Expand Down Expand Up @@ -509,7 +509,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 | Publicly accessible, reflecting public pages only |
| [llms.txt and llms-full.txt](/ai/llmstxt) | Full support | Available behind authentication, so AI tools may not be able to access the files | Publicly accessible, reflecting public pages only. [Custom files](/ai/llmstxt#custom-files-on-authenticated-sites) that link only to public pages are served publicly |

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L512

In general, use active voice instead of passive voice ('are served').
| [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 | Full support, respects user groups. Authenticated pages export with images and assets included. | Full support, respects user groups. Authenticated pages export with images and assets included. |
Expand Down
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,8 @@
"help-center/domain-already-claimed-by-another-organization",
"help-center/configure-oauth-with-auth0",
"help-center/private-repo-missing-when-creating-second-deployment",
"help-center/static-file-not-served"
"help-center/static-file-not-served",
"help-center/custom-llms-txt-shows-generated-index"
]
}
]
Expand Down
3 changes: 2 additions & 1 deletion es.json
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,8 @@
"es/help-center/domain-already-claimed-by-another-organization",
"es/help-center/configure-oauth-with-auth0",
"es/help-center/private-repo-missing-when-creating-second-deployment",
"es/help-center/static-file-not-served"
"es/help-center/static-file-not-served",
"es/help-center/custom-llms-txt-shows-generated-index"
]
}
]
Expand Down
11 changes: 11 additions & 0 deletions es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,14 @@ Mintlify aloja automáticamente un archivo `llms-full.txt` en la raíz de tu pro
Para agregar un archivo personalizado `llms.txt` o `llms-full.txt`, crea un archivo `llms.txt` o `llms-full.txt` en la raíz de tu proyecto. Agregar un archivo personalizado reemplazará el archivo generado automáticamente con el mismo nombre. Si eliminas un archivo personalizado, Mintlify restaura el archivo generado automáticamente.

Tu archivo personalizado `llms.txt` o `llms-full.txt` debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta [Format](https://llmstxt.org/#format) en la especificación de `llms.txt` para obtener más información sobre secciones opcionales y buenas prácticas.

<div id="custom-files-on-authenticated-sites">
### Archivos personalizados en sitios autenticados
</div>

En los sitios con [autenticación](/es/deploy/authentication-setup) habilitada, Mintlify comprueba las páginas que tu archivo personalizado enlaza o incrusta cada vez que tu sitio se actualiza:

- Si todas las páginas enlazadas son públicas, Mintlify sirve tu archivo personalizado a todos los visitantes, incluidas las herramientas de IA que no pueden autenticarse.
- Si alguna página enlazada requiere autenticación o está restringida a grupos de usuarios, Mintlify sirve tu archivo personalizado solo a usuarios autenticados. Los visitantes anónimos reciben el archivo generado automáticamente en su lugar.

Si los visitantes anónimos ven el archivo generado en lugar de tu archivo personalizado, consulta [Corregir un llms.txt personalizado que los visitantes anónimos no pueden ver](/es/help-center/custom-llms-txt-shows-generated-index).
2 changes: 1 addition & 1 deletion es/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,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 | Disponible tras autenticación, por lo que es posible que las herramientas de IA no puedan acceder a los archivos | Accesibles públicamente, reflejando solo las páginas públicas. Los [archivos personalizados](/es/ai/llmstxt#custom-files-on-authenticated-sites) que solo enlazan a páginas públicas se sirven públicamente |
| [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 | Compatibilidad completa, respeta los grupos de usuarios. Las páginas autenticadas se exportan con imágenes y recursos incluidos. | Compatibilidad completa, respeta los grupos de usuarios. Las páginas autenticadas se exportan con imágenes y recursos incluidos. |
Expand Down
28 changes: 28 additions & 0 deletions es/help-center/custom-llms-txt-shows-generated-index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Corregir un llms.txt personalizado que los visitantes anónimos no pueden ver"
description: "Diagnostica por qué los visitantes anónimos de tu sitio de documentación autenticado reciben el llms.txt generado en lugar de tu archivo llms.txt o llms-full.txt personalizado."
keywords: ["custom llms.txt not showing", "llms.txt generated index", "llms-full.txt override", "authentication llms.txt", "anonymous visitors"]
---

En los sitios de documentación con [autenticación](/es/deploy/authentication-setup) habilitada, Mintlify solo sirve un [archivo `llms.txt` o `llms-full.txt` personalizado](/es/ai/llmstxt#custom-files) a los visitantes anónimos cuando todas las páginas a las que hace referencia el archivo son públicas. Si tu archivo personalizado hace referencia a alguna página protegida, los visitantes anónimos reciben el archivo generado automáticamente en su lugar, mientras que los usuarios autenticados siguen recibiendo tu archivo personalizado.

## Cómo decide Mintlify la visibilidad

Cada vez que tu sitio se actualiza, Mintlify examina tu archivo personalizado en busca de referencias a páginas en dos formas:

- Enlaces de Markdown, como `[Quickstart](/quickstart)` o `[Quickstart](https://docs.example.com/quickstart.md)`.
- Líneas `Source:` que incrustan el contenido de una página, que aparecen en archivos de estilo `llms-full.txt`.

Una página referenciada cuenta como pública cuando su frontmatter establece `public: true` y no tiene restricción de `groups`. Si todas las páginas referenciadas son públicas, o el archivo no hace referencia a ninguna página, Mintlify sirve el archivo personalizado a todos. Si alguna página referenciada está protegida, el archivo personalizado solo se sirve a usuarios autenticados.

Esta comprobación se aplica a los archivos `llms.txt` y `llms-full.txt` personalizados. Otros archivos de reemplazo, como `robots.txt` y `sitemap.xml`, no se ven afectados.

## Solucionar el problema

1. Abre tu archivo personalizado y enumera todas las páginas que enlaza o incrusta.
2. Para cada página, confirma que el frontmatter de la página incluye `public: true` y no tiene la propiedad `groups`. Consulta [Hacer páginas públicas](/es/deploy/authentication-setup#make-pages-public).
3. Elimina o reemplaza las referencias a páginas que deben permanecer protegidas.
4. Confirma el cambio y espera a que se complete el despliegue. Mintlify vuelve a evaluar la visibilidad en cada actualización.
5. Verifica solicitando el archivo sin iniciar sesión, por ejemplo `curl https://docs.example.com/llms.txt`.

Si todo tu sitio requiere autenticación, no hay páginas públicas a las que hacer referencia, por lo que un archivo personalizado que enlaza a tu documentación siempre se sirve tras la autenticación.
3 changes: 2 additions & 1 deletion fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,8 @@
"fr/help-center/domain-already-claimed-by-another-organization",
"fr/help-center/configure-oauth-with-auth0",
"fr/help-center/private-repo-missing-when-creating-second-deployment",
"fr/help-center/static-file-not-served"
"fr/help-center/static-file-not-served",
"fr/help-center/custom-llms-txt-shows-generated-index"
]
}
]
Expand Down
11 changes: 11 additions & 0 deletions fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,14 @@ Mintlify héberge automatiquement un fichier `llms-full.txt` à la racine de vot
Pour ajouter un fichier `llms.txt` ou `llms-full.txt` personnalisé, créez un fichier `llms.txt` ou `llms-full.txt` à la racine de votre projet. L'ajout d'un fichier personnalisé remplace le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, Mintlify restaure le fichier généré automatiquement.

Votre fichier `llms.txt` ou `llms-full.txt` personnalisé doit comporter le titre du site en tant que niveau de titre H1. Le reste du contenu est facultatif. Consultez [Format](https://llmstxt.org/#format) dans la spécification `llms.txt` pour plus d'informations sur les sections facultatives et les bonnes pratiques.

<div id="custom-files-on-authenticated-sites">
### Fichiers personnalisés sur les sites authentifiés
</div>

Sur les sites avec l'[authentification](/fr/deploy/authentication-setup) activée, Mintlify vérifie les pages que votre fichier personnalisé lie ou intègre à chaque mise à jour de votre site :

- Si toutes les pages liées sont publiques, Mintlify sert votre fichier personnalisé à tous les visiteurs, y compris les outils d'IA qui ne peuvent pas s'authentifier.
- Si une page liée nécessite une authentification ou est restreinte à des groupes d'utilisateurs, Mintlify ne sert votre fichier personnalisé qu'aux utilisateurs authentifiés. Les visiteurs anonymes reçoivent le fichier généré automatiquement à la place.

Si les visiteurs anonymes voient le fichier généré au lieu de votre fichier personnalisé, consultez [Corriger un llms.txt personnalisé invisible pour les visiteurs anonymes](/fr/help-center/custom-llms-txt-shows-generated-index).
2 changes: 1 addition & 1 deletion fr/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,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 | Disponible derrière l’authentification, les outils d’IA peuvent donc ne pas avoir accès aux fichiers | Accessibles publiquement, en ne reflétant que les pages publiques. Les [fichiers personnalisés](/fr/ai/llmstxt#custom-files-on-authenticated-sites) qui ne lient que des pages publiques sont servis publiquement |
| [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 | Prise en charge complète, respecte les groupes d'utilisateurs. Les pages authentifiées sont exportées avec les images et les ressources incluses. | Prise en charge complète, respecte les groupes d'utilisateurs. Les pages authentifiées sont exportées avec les images et les ressources incluses. |
Expand Down
28 changes: 28 additions & 0 deletions fr/help-center/custom-llms-txt-shows-generated-index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Corriger un llms.txt personnalisé invisible pour les visiteurs anonymes"
description: "Diagnostiquez pourquoi les visiteurs anonymes de votre site de documentation authentifié reçoivent le llms.txt généré au lieu de votre fichier llms.txt ou llms-full.txt personnalisé."
keywords: ["custom llms.txt not showing", "llms.txt generated index", "llms-full.txt override", "authentication llms.txt", "anonymous visitors"]
---

Sur les sites de documentation avec l'[authentification](/fr/deploy/authentication-setup) activée, Mintlify ne sert un [fichier `llms.txt` ou `llms-full.txt` personnalisé](/fr/ai/llmstxt#custom-files) aux visiteurs anonymes que lorsque toutes les pages référencées par le fichier sont publiques. Si votre fichier personnalisé référence une page protégée, les visiteurs anonymes reçoivent le fichier généré automatiquement à la place, tandis que les utilisateurs authentifiés reçoivent toujours votre fichier personnalisé.

## Comment Mintlify détermine la visibilité

À chaque mise à jour de votre site, Mintlify analyse votre fichier personnalisé à la recherche de références à des pages sous deux formes :

- Les liens Markdown, comme `[Quickstart](/quickstart)` ou `[Quickstart](https://docs.example.com/quickstart.md)`.
- Les lignes `Source:` qui intègrent le contenu d'une page, présentes dans les fichiers de type `llms-full.txt`.

Une page référencée compte comme publique lorsque son frontmatter définit `public: true` et qu'elle n'a pas de restriction `groups`. Si toutes les pages référencées sont publiques, ou si le fichier ne référence aucune page, Mintlify sert le fichier personnalisé à tout le monde. Si une page référencée est protégée, le fichier personnalisé n'est servi qu'aux utilisateurs authentifiés.

Cette vérification s'applique aux fichiers `llms.txt` et `llms-full.txt` personnalisés. Les autres fichiers de remplacement, comme `robots.txt` et `sitemap.xml`, ne sont pas concernés.

## Résoudre le problème

1. Ouvrez votre fichier personnalisé et listez toutes les pages qu'il lie ou intègre.
2. Pour chaque page, confirmez que le frontmatter de la page inclut `public: true` et n'a pas de propriété `groups`. Consultez [Rendre des pages publiques](/fr/deploy/authentication-setup#make-pages-public).
3. Supprimez ou remplacez les références aux pages qui doivent rester protégées.
4. Validez la modification et attendez la fin du déploiement. Mintlify réévalue la visibilité à chaque mise à jour.
5. Vérifiez en demandant le fichier sans vous connecter, par exemple `curl https://docs.example.com/llms.txt`.

Si l'ensemble de votre site nécessite une authentification, il n'y a pas de pages publiques à référencer, donc un fichier personnalisé qui lie votre documentation est toujours servi derrière l'authentification.
Loading