Jamdesk Documentation logo

Wie Jamdesk funktioniert

Von Git-Push zu Live-Dokumentation in unter 60 Sekunden. Erfahren Sie, wie Jamdesk Ihre Dokumentationsseite ohne Infrastruktur erstellt, bereitstellt und optimiert.

Jamdesk erstellt Dokumentationsseiten aus MDX-Dateien in Ihrem GitHub-Repository. Sie schreiben Markdown mit React-Komponenten, pushen zu GitHub, und Ihre Website ist in unter 60 Sekunden in einem globalen CDN live. Ihre Inhalte bleiben als reine MDX-Dateien in Ihrem Repository, sodass Sie sie jederzeit in ein anderes Tool übertragen können.

Architekturüberblick

Ihr Repository ist die maßgebliche Quelle. Jamdesk verbindet sich damit, erstellt Ihre Website und stellt sie in einem globalen Edge-Netzwerk bereit. Sie müssen keine Infrastruktur verwalten.

So gelangen Inhalte von Ihrem Repository zu Ihren Benutzern

Die Build-Pipeline

Vom Anfang bis zum Ende dauert dies normalerweise 30–60 Sekunden. Builds sind schnell, weil Jamdesk Seiten nicht vorab rendert. Ihre unverarbeiteten Inhalte gelangen an den Edge, und Seiten werden bei Bedarf gerendert, wenn Besucher sie anfordern.

1
Quellabruf

Sie pushen in Ihren verbundenen GitHub-Branch (oder klicken im Dashboard auf Rebuild). Jamdesk klont Ihr Repository und findet Ihr Dokumentationsverzeichnis.

2
Validierung

Ihre docs.json-Konfiguration wird anhand des Schemas validiert, und interne Links werden auf fehlerhafte Seiten und ungültige Anker geprüft.

3
Inhaltsverarbeitung

Jamdesk erstellt aus Ihren Inhalten den Suchindex, Einbettungen für den KI-Chat, die Sitemap, llms.txt und Weiterleitungsregeln.

4
Am Edge bereitstellen

Inhalte werden in das CDN hochgeladen und an mehr als 300 Edge-Standorte verteilt. Da nur geänderte Dateien übertragen werden, sind erneute Bereitstellungen schnell.

In jeder Website enthalten

Jede Website enthält diese Funktionen standardmäßig. Es ist keine Konfiguration erforderlich.

KI-Suche

Eine Suche in natürlicher Sprache, die die Absicht versteht, nicht nur Schlüsselwörter. Unterstützt durch Vektor-Einbettungen, die beim Build aus Ihren Inhalten erstellt werden.

llms.txt

Ein KI-lesbarer Index gemäß der Spezifikation von llmstxt.org. Programmierassistenten und KI-Agenten können Ihre Dokumentation direkt verwenden.

SEO-Grundlagen

Sitemap, robots.txt, Open-Graph-Bilder und Meta-Tags. Ihre Dokumentation kann ab dem ersten Bereitstellen indexiert werden.

Integrierte Analysen

Datenschutzorientiertes Analytics-Dashboard, das keine Cookies benötigt. Oder verwenden Sie Ihre eigene Lösung: Jamdesk unterstützt Google Analytics, Plausible, PostHog und weitere.

Was einen Build auslöst

Ein Git-Push in Ihren verbundenen Branch, die Schaltfläche Rebuild im Dashboard oder jamdesk deploy über die CLI. Wenn Sie mehrere Commits in kurzer Folge pushen, fasst Jamdesk sie zu einem Build zusammen, damit keine Ressourcen verschwendet werden.

Operative Details zu Statusüberwachung, Rollbacks, Umgebungsvariablen und Branch-Bereitstellungen finden Sie unter Build- und Bereitstellungslebenszyklus.

Sicherheit und Infrastruktur

Sie müssen sich normalerweise nicht darum kümmern. Falls Ihr Sicherheitsteam jedoch nachfragt: Builds laufen in isolierten Containern, und Ihre GitHub-App-Verbindung ist schreibgeschützt.

Minimale Berechtigungen

Die GitHub-App fordert nur Lesezugriff auf die von Ihnen ausgewählten Repositorys an. Die App hat keinen Schreibzugriff und fordert keine organisationsweiten Bereiche an.

Isolierte Builds

Jeder Build erhält einen eigenen Container, der nach der Bereitstellung zerstört wird. Zwischen Builds oder Kunden bleibt nichts erhalten.

HTTPS überall

Automatische SSL-Zertifikate für benutzerdefinierte Domains und Subdomains. Zertifikate werden automatisch ausgestellt und erneuert.

Globales CDN

Bereitstellung über das Netzwerk von Cloudflare mit mehr als 300 Edge-Standorten und 99.9 % Verfügbarkeit.

Leistung

Ob Ihre Dokumentation gefunden wird, hängt teilweise davon ab, wie schnell sie geladen wird. Google verwendet Core Web Vitals als Ranking-Signal, und KI-Crawler wie GPTBot und ClaudeBot geben sich 1–5 Sekunden pro Seite. Wenn Ihre Dokumentation in diesem Zeitfenster nicht geladen wird, wird sie nicht zitiert.

Jede Jamdesk-Website wird vom Edge mit einer Zeit bis zum ersten Byte von unter 50 ms ausgeliefert. Das ist schnell genug für Googles Ranking-Schwellenwerte und damit KI-Crawler die Inhalte abrufen und zitieren können.

MetrikTypischer Wert
Build-Zeit30–60 Sekunden
Verteilung der Bereitstellung< 30 Sekunden
Erstes Byte (Edge)< 50 ms
Vollständiger Seitenaufbau< 500 ms

Nächste Schritte

Projekt erstellen

Richten Sie im Dashboard eine neue Dokumentationswebsite ein

GitHub verbinden

Verknüpfen Sie Ihr Repository, um automatische Builds zu aktivieren

Lokal in der Vorschau anzeigen

Verwenden Sie die Jamdesk CLI, um Ihre Dokumentation vor dem Push zu prüfen und in der Vorschau anzuzeigen