Extensión de URL .md
.md a la URL de cualquier página para ver una versión en Markdown.
Encabezado Accept
Accept: text/markdown o Accept: text/plain a la URL de cualquier página para recibir la versión Markdown en lugar de HTML. Esto es útil para herramientas de IA e integraciones que obtienen contenido de documentación de forma programática.
Contenido específico por audiencia
<Visibility for="humans"> aparece en la página web, pero no en la salida Markdown. El contenido envuelto en <Visibility for="agents"> aparece en la salida Markdown, pero no en la página web.
Páginas de referencia de API
markdown.schema como false en tu docs.json:
Instrucciones personalizadas para agentes
markdown.instructions en tu docs.json. Úsalo para directrices a nivel de sitio como citar una versión de la API, preferir un SDK específico o seguir tu terminología.
Proporciona una sola cadena:
Example agent instructions string
Example agent instructions array
Agent Instructions en la salida Markdown:
Example rendered agent instructions
- La exportación en Markdown de cada página, incluidas las páginas de referencia de API.
- Tu archivo
llms.txt, después del título y la descripción del sitio. - Tu archivo
llms-full.txt.
Comentarios de agentes
<AgentInstructions> a la exportación Markdown de cada página que indica a los agentes cómo enviar comentarios sobre el contenido de la página.
Los agentes envían comentarios publicando en el endpoint con la ruta de la página y el texto del comentario.
Usa los comentarios de agentes para mejorar tus páginas para agentes en función de lo que encuentren incorrecto, desactualizado o confuso.
Autenticación
| Modo de autenticación | Comportamiento |
|---|---|
| Sin autenticación | Todas las URLs .md son de acceso público. |
| Autenticación parcial | Las URLs .md de páginas públicas son de acceso público. Las URLs .md de páginas protegidas requieren autenticación y respetan las restricciones de grupos de usuarios. |
| Autenticación completa | Todas las URLs .md requieren autenticación y respetan las restricciones de grupos de usuarios. |