Jamdesk-Dokumentation

Jamdesk ist ein Tool für Softwaredokumentation, das aus Ihren Markdown-Dateien Dokumentationswebsites erstellt. Verbinden Sie ein GitHub-Repository, schreiben Sie in MDX und stellen Sie Ihre Dokumentation in Sekunden weltweit bereit. Sie müssen keine Build-Pipeline einrichten und kein DevOps selbst übernehmen. Jede Website erzeugt eine llms.txt-Datei, damit KI-Tools Ihre Inhalte indexieren können.

Mit KI schreiben. Verwenden Sie Cursor, Claude oder einen beliebigen KI-Assistenten, um Ihre Dokumentation zu erstellen und zu bearbeiten. MDX ist ein Textformat, das KI-Tools nativ verstehen, sodass keine speziellen Prompts erforderlich sind.

Ein minimales Jamdesk-Projekt

my-docs/
├── docs.json
└── introduction.mdx

Das ist alles, was Sie benötigen. In der Schnellstartanleitung erfahren Sie, wie Sie Ihr eigenes Projekt erstellen.

Sehen Sie sich den Quellcode dieser Dokumentation auf GitHub an. Es handelt sich um ein funktionierendes Jamdesk-Projekt, das Sie als Referenz verwenden können.

Enthaltene Funktionen

In Sekunden bereitstellen

Übertragen Sie Ihre Änderungen an GitHub, und Ihre Dokumentation wird in einem globalen CDN bereitgestellt. Keine Build-Konfigurationen oder CI-Pipelines.

In MDX schreiben

Standard-Markdown mit React-Komponenten für interaktive Elemente.

Themes und Branding

Wählen Sie zwischen Jam, Nebula oder Pulsar und überschreiben Sie anschließend Farben, Schriftarten und Stile, damit sie zu Ihrer Marke passen.

Integrierte Suche

Suche mit Cmd+K, die Ihre Inhalte automatisch indexiert.

Benötigen Sie private Dokumentation? Schützen Sie Ihre gesamte Website mit einem Passwort, sperren Sie einzelne Seiten mit private: true oder verwenden Sie SSO im Enterprise-Tarif. Weitere Informationen finden Sie unter Zugriffskontrolle.

Funktionsweise

In MDX schreiben

Erstellen Sie Dokumentation mit Markdown und optionalen React-Komponenten. Verwenden Sie Ihren bevorzugten Editor: VS Code, Cursor oder einen beliebigen Texteditor. KI-Tools wie Claude können MDX nativ erstellen und bearbeiten.

An GitHub übertragen

Committen Sie Ihre Änderungen und übertragen Sie sie. Sie müssen keinen Build-Befehl ausführen und kein Bereitstellungsskript pflegen.

In Sekunden live

Jamdesk erkennt Ihre Übertragung, erstellt Ihre Website und stellt sie in einem globalen CDN bereit. Ihre Dokumentation ist unter your-project.jamdesk.app live.

Was Sie erstellen können

Benutzeranleitungen, Funktionsdokumentation und Hilfezentren. Eine klare Navigation hilft Benutzern, schnell Antworten zu finden. Komponenten ansehen →

Weitere Funktionen

KI-Chat

Der integrierte Chat-Assistent beantwortet Fragen von Besuchern anhand Ihrer Dokumentation.

MCP-Integration

KI-Agenten fragen Ihre Dokumentation über das Model Context Protocol ab.

Integrierte Analysen

Seitenaufrufe, Suchanfragen und geografische Daten ohne Tools von Drittanbietern.

OpenAPI-Unterstützung

Generieren Sie automatisch API-Seiten aus Ihrer OpenAPI-Spezifikation ab Version 3.0.

Benutzerdefinierte Domains

Stellen Sie Ihre Dokumentation unter docs.yourcompany.com mit automatischem SSL bereit.

Für SEO optimiert

Meta-Tags, Open-Graph-Bilder und Sitemaps werden automatisch erstellt.

Erste Schritte

Schnellstart

Stellen Sie Ihre erste Dokumentationswebsite in 5 Minuten bereit

CLI-Anleitung

Richten Sie die lokale Entwicklung ein

MDX-Grundlagen

Lernen Sie, Dokumentation zu schreiben

Komponenten

Entdecken Sie die verfügbaren Komponenten