Jamdesk-Dokumentation
Erstellen Sie KI-taugliche Dokumentation mit Jamdesk, einem auf MDX und GitHub basierenden Tool. Sekundenschnell bereitstellen, mit integrierter Suche, Analysen und Themes.
Jamdesk ist ein Tool für Software-Dokumentation, das aus Ihren Markdown-Dateien Dokumentationsseiten erstellt. Verbinden Sie ein GitHub-Repository, schreiben Sie in MDX und stellen Sie in Sekunden weltweit bereit. Sie müssen keine Build-Pipeline einrichten und keine DevOps-Aufgaben selbst übernehmen. Jede Seite erzeugt eine Datei llms.txt, die KI-Tools zum Indexieren Ihrer Inhalte nutzen.
Mit KI schreiben. Verwenden Sie Cursor, Claude oder einen beliebigen KI-Assistenten, um Ihre Dokumentation zu erstellen und zu bearbeiten. KI-Tools lesen MDX nativ. Sie benötigen keine speziellen Prompts.
Ein minimales Jamdesk-Projekt
my-docs/
├── docs.json
└── introduction.mdxMehr brauchen Sie nicht. Eine Anleitung zum Erstellen Ihres ersten Projekts finden Sie im Quickstart.
Sehen Sie sich den Quellcode dieser Dokumentation auf GitHub an. Es ist ein funktionierendes Jamdesk-Projekt, das Sie als Referenz verwenden können.
Enthaltene Funktionen
Private Dokumentation benötigt? Schützen Sie Ihre gesamte Website mit einem Passwort, sperren Sie einzelne Seiten mit private: true oder nutzen Sie SSO im Enterprise-Tarif. Siehe Zugriffskontrolle.
Funktionsweise
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 erzeugen und bearbeiten.
Committen Sie Ihre Änderungen und pushen Sie sie. Sie müssen keinen Build-Befehl ausführen und kein Deploy-Skript pflegen.
Jamdesk erkennt Ihren Push, baut Ihre Website und stellt sie in einem globalen CDN bereit. Ihre Dokumentation ist unter your-project.jamdesk.app erreichbar.
Was Sie erstellen können
Benutzerhandbücher, Funktionsdokumentation und Hilfecenter. Eine klare Navigation hilft Lesern, Antworten zu finden. Komponenten ansehen →