Schnellstart: In 5 Minuten bereitstellen

Jamdesk ist eine Dokumentationssoftware, die ein GitHub-Repository mit Markdown als gehostete Dokumentationsseite veröffentlicht und automatisch eine KI-lesbare Ausgabe (llms.txt, seitenbezogene .md-Endpoints und einen MCP-Server) generiert.

Stellen Sie eine Dokumentationsseite mit nur zwei Dateien bereit: docs.json und einer MDX-Seite. Wählen Sie den Pfad, der zu Ihrem Ausgangspunkt passt.

Voraussetzungen

Sie benötigen:

• Ein GitHub-Konto
• Ein Repository mit Ihrer Dokumentation (oder wir erstellen eines)

Option 1: Mit der Startervorlage beginnen

Der schnellste Weg zum Einstieg. Die Startervorlage enthält Beispielinhalte, eine OpenAPI-Spezifikation und Beispiele für jede Komponente, damit Sie sehen können, wie alles funktioniert, bevor Sie die Inhalte durch Ihre eigenen ersetzen.

Option 2: Vorhandenes Repository verbinden

Sie haben bereits ein Repository mit Jamdesk-kompatibler Dokumentation? Verbinden Sie es direkt. Wenn Sie von Mintlify oder einer anderen Dokumentationsplattform migrieren, verwenden Sie zuerst Option 3.

Option 3: Von Mintlify oder einer anderen Dokumentationsplattform migrieren

Sie haben bereits Dokumentation in Mintlify, GitBook, Docusaurus, ReadMe, Confluence oder einer anderen Plattform? Beginnen Sie mit dem Migrationsleitfaden, bevor Sie ein neues Projekt erstellen. Er behandelt den Befehl jamdesk migrate für Mintlify sowie die manuellen Schritte für andere Dokumentationstools. Verbinden Sie nach der Migration das migrierte Repository mithilfe von Option 2.

Was enthält ein Docs-Projekt

Ein minimales Jamdesk-Projekt besteht aus zwei Dingen:

my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page

Für größere Websites finden Sie unter Verzeichnisstruktur empfohlene Ordner, Assets und Snippets.

docs.json

Die Konfigurationsdatei, die Ihre Website definiert:

{
  "$schema": "https://jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction"]
      }
    ]
  }
}

Eine Übersicht über alle Konfigurationsoptionen finden Sie in der docs.json-Referenz.

MDX-Seiten

Dokumentationsseiten, die in MDX verfasst sind:

---
title: Introduction
description: Welcome to the docs
---

# Welcome

This is your first documentation page.

Unter MDX-Grundlagen finden Sie Informationen zu Frontmatter, Überschriften, Links und Komponentensyntax.

Lokale Entwicklung

Mit der Jamdesk CLI können Sie Änderungen lokal in der Vorschau anzeigen, bevor Sie sie an GitHub übertragen. So lassen sich MDX-Syntaxfehler erkennen, bevor sie Ihre Live-Seite erreichen. Alle Installationsmethoden und Befehle finden Sie in der Übersicht zur Jamdesk CLI.

Änderungen lokal in der Vorschau anzeigen:

npm install -g jamdesk
cd my-docs
jamdesk dev

Öffnen Sie http://localhost:3000, um Ihre Dokumentation mit Hot Reload zu sehen.

Weitere Seiten hinzufügen

1. Erstellen Sie eine neue MDX-Datei:

---
title: Getting Started
description: Learn the basics
---

Your content here...

2. Fügen Sie sie zu docs.json hinzu:

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}

3. Übertragen Sie die Änderungen per Push an GitHub – Ihre neue Seite wird automatisch bereitgestellt.

Weitere Verknüpfungsmuster, einschließlich Ankern und Cards, finden Sie unter Links und Navigation.

Benutzerdefinierte Domain

Fügen Sie unter Settings → Domains Ihre eigene Domain hinzu:

1. Geben Sie Ihre Domain ein (z. B. docs.example.com)
2. Fügen Sie die angezeigten DNS-Einträge hinzu
3. Warten Sie auf die Verifizierung (bis zu 48 Stunden)

SSL-Zertifikate werden automatisch bereitgestellt. Vollständiger Leitfaden →

Benötigen Sie Hilfe?

Kommen Sie bei etwas nicht weiter? Durchsuchen Sie das Help Center nach Leitfäden zu Einrichtung, Abrechnung und Fehlerbehebung. Oder sprechen Sie mit einer echten Person: Öffnen Sie das Chat-Widget in der unteren Ecke einer beliebigen Jamdesk-Seite oder schreiben Sie uns eine E-Mail an support@jamdesk.com. Wir antworten schnell.

Vollständige Referenz

Alles, was Sie erstellen und ausführen können, ist in drei Referenzen dokumentiert: jede MDX-Komponente, jeder CLI-Befehl und jede docs.json-Konfigurationsoption.

Wie geht es weiter?