Markdown-Quelle
Greife auf die rohe Markdown-Quelle jeder Doku-Seite zu, indem du .md an die URL anhängst – für KI-Tools, Skripte und Content-Pipelines.
KI-Tools verarbeiten Markdown effizienter als gerendertes HTML. Jamdesk stellt die rohe Markdown-Quelle jeder Seite bereit, indem du .md an eine beliebige URL anhängst. Keine Authentifizierung erforderlich.
.md-URL-Erweiterung
Hänge .md an die URL einer beliebigen Dokumentationsseite an, um die rohe Quelle statt des gerenderten HTML abzurufen:
# Rendered page
https://acme.jamdesk.app/getting-started
# Raw Markdown source
https://acme.jamdesk.app/getting-started.mdDies funktioniert bei jeder Pfadtiefe. So sieht die Antwort aus:
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>Die Antwort ist die exakte Quelldatei aus deinem Repository, einschließlich Frontmatter und Komponententags.
Benutzerdefinierte Domains
Rohe Inhalte funktionieren auch auf benutzerdefinierten Domains. Verwende dieselbe URL, die deine Leser sehen, und hänge .md an:
# 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.mdInhaltsformat
Der rohe Inhalt ist Markdown, erweitert um Komponententags wie <Note>, <Steps> und <Tabs>. Standardmäßige Markdown-Parser behandeln Komponententags als rohes HTML. Eine vollständige Syntaxreferenz findest du unter Markdown-Grundlagen.
Was eine Endpoint-Seite exportiert
Eine openapi:-Seite hat fast keinen eigenen Textkörper – der Endpoint wird aus deiner Spezifikation gerendert –, daher wird ihr Markdown-Export stattdessen aus der Spezifikation abgeflacht. Ein Agent, der die Seite abruft, erhält Methode und Pfad, die Parameter mit ihren Beschreibungen, die Anfrage- und Antwortschemas sowie einen Abschnitt ## Authentication, der die von der Operation benötigten Sicherheitsschemata nennt: den Schematyp, den apiKey-Headernamen, das Bearer-Format und alle OAuth-2-Scopes.
Alternativen werden mit „Any one of“ gekennzeichnet, Schemata, die gemeinsam gesendet werden müssen, werden zusammen aufgeführt, und eine Operation, die sich mit security: [] ausdrücklich gegen Sicherheit entscheidet, gibt dies an, anstatt still zu bleiben. Das ist alles, was zum Erstellen einer funktionierenden Anfrage erforderlich ist, ohne die Spezifikation zu öffnen.
OpenAPI-Spezifikationen auf API-Referenzseiten
Wenn du das Markdown für eine API-Referenzseite abrufst (eine Seite, deren Frontmatter eine api:- oder openapi:-Spezifikation angibt), hängt Jamdesk einen kurzen Footer an, der KI-Agenten auf jede OpenAPI-Spezifikation in deinem Projekt verweist, gebündelt als einzelner Download:
---
📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://acme.jamdesk.app/api-specs.zipEs handelt sich um dieselbe api-specs.zip, die von der Aktion API-Spezifikation herunterladen angeboten und bei jeder Anfrage neu zusammengestellt wird. Der Zweck ist die Reichweite: Ein Agent, der eine einzelne Endpoint-Seite liest, erfährt, dass er den vollständigen maschinenlesbaren Vertrag mit einer einzigen Anfrage abrufen kann, statt jeden Endpoint einzeln zu durchsuchen. Der Footer erscheint nur auf API-Referenzseiten von Projekten, die mindestens eine Spezifikation haben; reguläre Leitfäden bleiben unverändert.
Antwortdetails
Header
| Header | Value | Purpose |
|---|---|---|
Content-Type | text/markdown; charset=utf-8 | Identifies content as Markdown |
Cache-Control | public, max-age=3600, s-maxage=86400 | Browser-cached 1 hour, CDN-cached 1 day (.md URLs) |
Vary | Accept | The same URL serves HTML or Markdown depending on the request's Accept header |
X-Robots-Tag | noindex, nofollow | Prevents search engine indexing |
Content-Disposition | inline | Displays in browser instead of downloading |
X-Frame-Options | DENY | Prevents embedding in iframes |
Content-Security-Policy | default-src 'none' | Blocks script execution |
Wenn du die kanonische URL einer Seite (ohne .md) mit dem Header Accept: text/markdown anforderst, wird dasselbe Markdown zurückgegeben, jedoch mit Cache-Control: private, no-store. Die Antwort verwendet denselben Cache-Schlüssel wie die HTML-Seite und wird daher niemals zwischengespeichert.
Fehlerantworten
| Status | Meaning |
|---|---|
308 | Trailing slash redirect (e.g., /intro.md/ redirects to /intro.md) |
404 | Page does not exist (returns a short plain-text error, not Markdown) |
500 | Server error (returns an HTML error page) |
Verwendung mit KI-Tools
Markdown-Quell-URLs lassen sich gut mit dem MCP-Server kombinieren. Verwende searchDocs, um Seiten nach Schlüsselwörtern zu finden, und rufe anschließend die rohe Quelle der passenden Seite ab:
# 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.mdDamit erhalten KI-Tools sowohl Zugriff auf die Suche als auch auf die vollständige Quelle deiner Dokumentation. Beide URLs funktionieren auch auf einer aktiven benutzerdefinierten Domain – https://docs.acme.com/_mcp und https://docs.acme.com/guides/authentication.md.