Markdown-Quelle
Rohe Markdown-Quelle jeder Dokumentationsseite abrufen, indem Sie .md an die URL anhängen. Strukturierter Text für KI-Tools, Skripte und Content-Pipelines.
KI-Tools verarbeiten Markdown effizienter als gerendertes HTML. Hängen Sie .md an eine beliebige Seiten-URL an, um die rohe Markdown-Quelle zu erhalten. Es ist keine Authentifizierung erforderlich.
.md-URL-Erweiterung
Hängen Sie .md an eine beliebige Dokumentationsseiten-URL an, um die rohe Quelle statt des gerenderten HTML zu erhalten:
# Rendered page
https://acme.jamdesk.app/getting-started
# Raw Markdown source
https://acme.jamdesk.app/getting-started.mdDies funktioniert für jede 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 Ihrem Repository, einschließlich Frontmatter und Komponenten-Tags.
Benutzerdefinierte Domains
Hängen Sie .md an die eigene Domain-URL an, die Ihre Leser sehen:
# 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.mdWebsite-Root und Sprachpfade
Der Site-Root und ein nackter Sprach-Root liefern die Seite, die ihre HTML-Versionen zeigen: die erste Seite in Ihrer Navigation bzw. in der Navigation dieser Sprache. Es gibt keine Weiterleitung. Das Markdown kommt bereits bei der ersten Anfrage zurück.
# 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.mdEin Projekt mit einer echten index.mdx-Seite liefert diese Seite weiterhin unter /index.md und im Root aus. Der Root gibt 404 zurück, wenn die Datei der ersten Navigationsseite fehlt, wie bei jeder anderen fehlenden Seite.
Inhaltsformat
Der rohe Inhalt ist Markdown, erweitert um Komponenten-Tags wie <Note>, <Steps> und <Tabs>. Standard-Markdown-Parser behandeln Komponenten-Tags als rohes HTML. Die vollständige Syntaxreferenz finden Sie unter Markdown-Grundlagen.
Was eine Endpoint-Seite exportiert
Eine openapi:-Seite hat kaum einen eigenen Textkörper. Jamdesk rendert den Endpunkt aus Ihrer Spezifikation. Ihr Markdown-Export wird stattdessen aus der Spezifikation abgeflacht. Ein Agent, der sie abruft, erhält die Methode und den Pfad, die Parameter mit ihren Beschreibungen, die Request- und Response-Schemata sowie einen Abschnitt ## Authentication, der die für die Operation erforderlichen Sicherheitsschemata nennt: den Schema-Typ, den apiKey-Headernamen, das Bearer-Format und etwaige OAuth-2-Scopes.
Alternativen sind mit „Any one of“ gekennzeichnet. Schemata, die alle gesendet werden müssen, sind gemeinsam aufgeführt. Eine Operation, die sich mit security: [] abmeldet, wird als solche ausgewiesen. Das ist alles, was ein Agent braucht, um eine funktionierende Anfrage zu bauen, ohne die Spezifikation zu öffnen.
OpenAPI-Spezifikationen auf API-Referenzseiten
Das Markdown einer API-Referenzseite (deren Frontmatter eine api:- oder openapi:-Spezifikation deklariert) endet mit einem kurzen Footer. Er verweist KI-Agenten auf jede OpenAPI-Spezifikation in Ihrem Projekt, gebündelt als ein einziger Download:
---
📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://acme.jamdesk.app/api-specs.zipEs ist dieselbe api-specs.zip wie bei der Aktion API-Spezifikation herunterladen, die bei jeder Anfrage neu erstellt wird. Ein Agent, der eine einzelne Endpunktseite liest, erfährt, dass er den vollständigen maschinenlesbaren Vertrag mit einer Anfrage abrufen kann. Er muss nicht jeden Endpunkt einzeln auslesen. Der Footer erscheint nur auf API-Referenzseiten von Projekten mit mindestens einer Spezifikation.
Antwortdetails
Header
| Header | Wert | Zweck |
|---|---|---|
Content-Type | text/markdown; charset=utf-8 | Kennzeichnet den Inhalt als Markdown |
Cache-Control | public, max-age=3600, s-maxage=86400 | Im Browser 1 Stunde gecacht, im CDN 1 Tag (.md-URLs) |
Vary | Accept | Dieselbe URL liefert je nach Accept-Header des Requests HTML oder Markdown |
X-Robots-Tag | noindex, nofollow | Verhindert die Indexierung durch Suchmaschinen |
Content-Disposition | inline | Zeigt den Inhalt im Browser an, statt ihn herunterzuladen |
X-Frame-Options | DENY | Verhindert das Einbetten in iframes |
Content-Security-Policy | default-src 'none' | Blockiert die Ausführung von Skripten |
Wird die kanonische URL einer Seite (ohne .md) mit dem Header Accept: text/markdown angefordert, kommt dasselbe Markdown mit Cache-Control: private, no-store zurück. Diese Antwort teilt sich einen Cache-Schlüssel mit der HTML-Seite. Sie wird niemals gecacht.
Fehlerantworten
| Status | Bedeutung |
|---|---|
308 | Weiterleitung bei abschließendem Schrägstrich (z. B. wird /intro.md/ nach /intro.md weitergeleitet) |
404 | Seite existiert nicht (liefert eine kurze Nur-Text-Fehlermeldung, kein Markdown). Der Site-Root und Sprach-Roots verweisen auf die erste Navigationsseite und liefern nur dann 404, wenn auch deren Datei fehlt |
500 | Serverfehler (liefert eine HTML-Fehlerseite) |
Verwendung mit KI-Tools
Verwenden Sie searchDocs auf dem MCP-Server, um Seiten per Stichwort zu finden. Rufen Sie danach die rohe Quelle der gefundenen 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.mdSo erhalten KI-Tools Such- und Vollquellenzugriff auf Ihre Dokumentation. Die URLs funktionieren auch auf einer Live-Custom-Domain: https://docs.acme.com/_mcp und https://docs.acme.com/guides/authentication.md.