Extensión de URL .md
.md a la URL de cualquier página para ver una versión en Markdown.
Abrir esta página como Markdown
Los enlaces a otras páginas de tu navegación apuntan a sus versiones en Markdown, de modo que los agentes que siguen un enlace continúan leyendo Markdown. Por ejemplo, [Quickstart](/quickstart#install) se convierte en [Quickstart](/quickstart.md#install) en la salida Markdown. Los enlaces a páginas que no están en tu navegación, las imágenes, las URL externas y los enlaces dentro de bloques de código se mantienen tal como están escritos.
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.
Páginas inexistentes
llms.txt), a tu archivo de documentación completa (llms-full.txt) y hasta a tres páginas relacionadas según la ruta solicitada.
Example Markdown 404 response
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.
Componentes y HTML
Componentes
Un componente sin forma propia en Markdown conserva su texto. Su
title aparece en negrita, o como enlace si también tiene un href, seguido de su descripción o sus elementos hijos.
Variation y View se mantienen como etiquetas, porque seleccionan contenido en lugar de mostrarlo.
HTML
- Elimina contenedores como
divyspan. Su contenido se conserva. - Los encabezados, enlaces, imágenes y el texto en negrita, cursiva o código se convierten en Markdown.
- Elimina los atributos
class,className,styleydata-*. Los atributosid,href,src,alty ARIA se conservan. - Cuando una imagen solo para modo claro (
dark:hidden) está junto a una imagen solo para modo oscuro (hiddencondark:block,dark:inline,dark:inline-block,dark:flexodark:grid), la copia oscura no se incluye. Una imagen solo para modo oscuro sin una copia clara al lado se conserva.
aria-label, luego el title y, por último, Open.
Snippets
<Snippet file="path/to/snippet.mdx" />. Las exportaciones a Markdown incluyen cualquier variable de docs.json. Si no se encuentra un archivo de snippet referenciado, la exportación a Markdown incluye la etiqueta.
<Visibility> dentro de un snippet o de un componente personalizado sigue las mismas reglas de audiencia que en la página. Úsalo cuando un componente personalizado sea visual y quieras que los agentes lean una forma más sencilla, como una Card.
Componentes de React personalizados
- Componentes con salida estática: se convierten en Markdown. Por ejemplo, un componente que devuelve un enlace, una lista o una tabla aparece como ese enlace, esa lista o esa tabla.
- Componentes interactivos: generan su salida a partir del estado o de APIs del navegador, como calculadoras, galerías con filtros y gráficos. Solo conservan sus elementos hijos y sus props
title,description,altyhref. Un componente sin ninguno de ellos se omite. - Datos importados: como un objeto que se pasa a un componente como prop, no aparecen en las exportaciones a Markdown.
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.