Fuente Markdown

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 sin procesar 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 el código fuente sin procesar en lugar del HTML renderizado:

# Rendered page
https://acme.jamdesk.app/getting-started

# Raw Markdown source
https://acme.jamdesk.app/getting-started.md

Esto 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 sin procesar 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.md

Formato del contenido

El contenido sin procesar es Markdown extendido 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.

Especificaciones de OpenAPI en páginas de referencia de la API

Cuando obtienes el Markdown de una página de referencia de la API (es decir, una página cuyo frontmatter declara una especificación api: u openapi:), Jamdesk añade al final un breve pie de página que indica a los agentes de IA dónde encontrar todas las especificaciones de 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.zip

Es el mismo api-specs.zip que ofrece la acción Descargar especificación de la API, generado de nuevo en cada solicitud. La idea es ampliar el alcance: un agente que lee la página de un endpoint descubre que puede obtener el contrato completo legible por máquinas en una sola solicitud, en lugar de rastrear cada endpoint. El pie de página solo aparece en las páginas de referencia de la API de proyectos que tienen al menos una especificación; las guías normales no se ven afectadas.

Detalles de la respuesta

Encabezados

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 la clave de caché con la página HTML, por lo que esa respuesta nunca se almacena en caché.

Respuestas de error

Uso con herramientas de IA

Las URLs de código fuente Markdown combinan bien con el Servidor MCP. Usa searchDocs para encontrar páginas por palabra clave y, después, obtén el código fuente sin procesar 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.md

Esto da a las herramientas de IA acceso tanto a la búsqueda como a la fuente completa 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.

¿Qué sigue?