Fuente Markdown
Accede a la fuente Markdown de cualquier página de documentación añadiendo .md a la URL. Texto estructurado para IA, scripts y pipelines de contenido.
Las herramientas de IA procesan Markdown de forma más eficiente que el HTML renderizado. Jamdesk pone a disposición el código fuente Markdown en bruto de cada página añadiendo .md a cualquier URL. No se requiere autenticación.
Extensión de URL .md
Añade .md a la URL de cualquier página de documentación para obtener la fuente en bruto en lugar del HTML renderizado:
# Rendered page
https://acme.jamdesk.app/getting-started
# Raw Markdown source
https://acme.jamdesk.app/getting-started.mdEsto funciona para cualquier profundidad de ruta. Así es como se ve la respuesta:
curl https://acme.jamdesk.app/getting-started.md---
title: Getting Started
description: Set up your first project in 5 minutes.
---
Welcome to the getting started guide.
## Prerequisites
<Note>You'll need Node.js 18 or later.</Note>La respuesta es el archivo fuente exacto de tu repositorio, incluidos el frontmatter y las etiquetas de componentes.
Dominios personalizados
El contenido en bruto también funciona en dominios personalizados. Usa la misma URL que ven tus lectores, con .md añadido:
# Docs served at root
curl https://docs.example.com/getting-started.md
# Docs served at /docs subpath
curl https://docs.example.com/docs/getting-started.mdRaíz del sitio y raíces de idioma
La raíz del sitio y una raíz de idioma exportan la página que muestran sus versiones HTML: la primera página de tu navegación, o de la navegación de ese idioma. No hay redirección: el Markdown se devuelve en la primera solicitud.
# All three return the first navigation page's Markdown
curl https://acme.jamdesk.app/index.md
curl -H "Accept: text/markdown" https://acme.jamdesk.app/
curl https://acme.jamdesk.app/fr.mdUn proyecto con una página index.mdx real sigue sirviendo esa página en /index.md y en la raíz. Si falta el archivo de la primera página de navegación, la raíz devuelve 404 como cualquier otra página faltante.
Formato del contenido
El contenido en bruto es Markdown ampliado con etiquetas de componentes como <Note>, <Steps> y <Tabs>. Los analizadores de Markdown estándar tratarán las etiquetas de componentes como HTML sin procesar. Consulta Conceptos básicos de Markdown para la referencia completa de la sintaxis.
Qué exporta una página de endpoint
Una página openapi: casi no tiene contenido propio — el endpoint se genera a partir de tu spec — así que su exportación en Markdown se aplana a partir del spec en su lugar. Un agente que la obtiene recibe el método y la ruta, los parámetros con sus descripciones, los esquemas de solicitud y respuesta, y una sección ## Authentication que nombra los esquemas de seguridad que requiere la operación: el tipo de esquema, el nombre del encabezado apiKey, el formato del bearer y cualquier scope de OAuth 2.
Las alternativas se etiquetan como «Any one of» (cualquiera de estas), los esquemas que deben enviarse todos juntos aparecen agrupados, y una operación que se excluye explícitamente con security: [] lo indica en lugar de quedar en silencio. Eso es todo lo necesario para construir una solicitud funcional sin abrir el spec.
Specs de OpenAPI en páginas de referencia de la API
Cuando obtienes el Markdown de una página de referencia de la API (cuyo frontmatter declara un spec api: u openapi:), Jamdesk añade un breve pie de página que dirige a los agentes de IA hacia todas las especificaciones OpenAPI de tu proyecto, agrupadas en una sola descarga:
---
📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://acme.jamdesk.app/api-specs.zipEs el mismo api-specs.zip que ofrece la acción Descargar la spec de la API, generado de nuevo en cada solicitud. El objetivo es el alcance: un agente que lee una página de endpoint aprende que puede obtener el contrato completo legible por máquina en una sola solicitud, en lugar de hacer scraping de cada endpoint. El pie de página solo aparece en las páginas de referencia de la API de proyectos que tienen al menos un spec; las guías normales no se ven afectadas.
Detalles de la respuesta
Encabezados
| Header | Value | Purpose |
|---|---|---|
Content-Type | text/markdown; charset=utf-8 | Identifica el contenido como Markdown |
Cache-Control | public, max-age=3600, s-maxage=86400 | Almacenado en caché del navegador 1 hora, en caché de CDN 1 día (URLs .md) |
Vary | Accept | La misma URL sirve HTML o Markdown según el encabezado Accept de la solicitud |
X-Robots-Tag | noindex, nofollow | Evita la indexación por motores de búsqueda |
Content-Disposition | inline | Se muestra en el navegador en lugar de descargarse |
X-Frame-Options | DENY | Evita la incrustación en iframes |
Content-Security-Policy | default-src 'none' | Bloquea la ejecución de scripts |
Solicitar la URL canónica de una página (sin .md) con el encabezado Accept: text/markdown devuelve el mismo Markdown, pero con Cache-Control: private, no-store. Comparte una clave de caché con la página HTML, por lo que esa respuesta nunca se almacena en caché.
Respuestas de error
| Status | Meaning |
|---|---|
308 | Redirección de barra final (por ejemplo, /intro.md/ redirige a /intro.md) |
404 | La página no existe (devuelve un breve error de texto plano, no Markdown). La raíz del sitio y las raíces de idioma se resuelven a la primera página de navegación y solo devuelven 404 cuando el archivo de esa página también falta |
500 | Error del servidor (devuelve una página de error HTML) |
Uso con herramientas de IA
Las URLs de fuente Markdown combinan bien con el servidor MCP. Usa searchDocs para encontrar páginas por palabra clave, y luego obtén la fuente en bruto de la página encontrada:
# 1. Search for a topic via MCP
curl -X POST https://acme.jamdesk.app/_mcp \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"searchDocs","arguments":{"query":"authentication"}}}'
# 2. Fetch the raw source of the top result
curl https://acme.jamdesk.app/guides/authentication.mdEsto le da a las herramientas de IA tanto la búsqueda como el acceso completo a la fuente de tu documentación. Ambas URLs también funcionan en un dominio personalizado activo — https://docs.acme.com/_mcp y https://docs.acme.com/guides/authentication.md.