Markdown 源码

与渲染后的 HTML 相比，AI 工具处理 Markdown 的效率更高。Jamdesk 允许在任意页面 URL 后追加 .md，以获取每个页面的原始 Markdown 源码。无需身份验证。

`.md` URL 扩展

在任意文档页面 URL 后追加 .md，即可获取原始源码，而不是渲染后的 HTML：

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

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

这适用于任意路径深度。以下是响应示例：

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>

响应内容是仓库中的原始文件，包括 frontmatter 和组件标签。

自定义域名

原始内容同样适用于自定义域名。使用读者看到的相同 URL，并在末尾追加 .md：

# 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

内容格式

原始内容是扩展了组件标签的 Markdown，例如 <Note>、<Steps> 和 <Tabs>。标准 Markdown 解析器会将组件标签视为原始 HTML。有关完整语法参考，请参阅 Markdown 基础。

API 参考页面上的 OpenAPI 规范

当你获取 API 参考页面的 Markdown 时（其 frontmatter 声明了 api: 或 openapi: 规范），Jamdesk 会附加一个简短页脚，指向项目中的每个 OpenAPI 规范，并将其打包为一个下载文件：

---

📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://acme.jamdesk.app/api-specs.zip

这是下载 API 规范操作提供的同一个 api-specs.zip，每次请求都会重新生成。这样做的意义在于扩大可访问范围：读取单个端点页面的代理可以了解到，它能够通过一次请求获取完整的机器可读契约，而不必抓取每个端点。该页脚仅出现在至少包含一个规范的项目的 API 参考页面上；普通指南不受影响。

响应详情

标头

Header	Value	Purpose
`Content-Type`	`text/markdown; charset=utf-8`	标识内容为 Markdown
`Cache-Control`	`public, max-age=3600, s-maxage=86400`	浏览器缓存 1 小时，CDN 缓存 1 天（`.md` URL）
`Vary`	`Accept`	同一 URL 根据请求的 `Accept` 标头提供 HTML 或 Markdown
`X-Robots-Tag`	`noindex, nofollow`	阻止搜索引擎建立索引
`Content-Disposition`	`inline`	在浏览器中显示，而不是下载
`X-Frame-Options`	`DENY`	阻止在 iframe 中嵌入
`Content-Security-Policy`	`default-src 'none'`	阻止脚本执行

使用标头 Accept: text/markdown 请求页面的规范 URL（不带 .md）时，也会返回相同的 Markdown，但其 Cache-Control 为 private, no-store。它与 HTML 页面共享缓存键，因此该响应不会被缓存。

错误响应

Status	Meaning
`308`	末尾斜杠重定向（例如，`/intro.md/` 重定向到 `/intro.md`）
`404`	页面不存在（返回简短的纯文本错误，而不是 Markdown）
`500`	服务器错误（返回 HTML 错误页面）

与 AI 工具结合使用

Markdown 源码 URL 与 MCP 服务器配合使用效果良好。使用 searchDocs 按关键词查找页面，然后获取匹配页面的原始源码：

# 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

这样，AI 工具即可同时搜索文档并访问完整源码。这两个 URL 在实时自定义域名上同样有效：https://docs.acme.com/_mcp 和 https://docs.acme.com/guides/authentication.md。

下一步？

MCP 服务器

将 AI 助手直接连接到文档

Markdown 基础

文档页面的 MDX 语法参考

.md URL 扩展