Schnellstart: In 5 Minuten bereitstellen

Jamdesk ist eine Dokumentationssoftware, die ein GitHub-Repository mit Markdown als gehostete Dokumentationsseite veröffentlicht. Sie erzeugt automatisch KI-lesbare Ausgaben: llms.txt, .md-Endpunkte pro Seite und einen MCP-Server.

Stellen Sie eine Dokumentationsseite mit zwei Dateien bereit: docs.json und einer MDX-Seite. Wählen Sie den Weg, 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

Dies ist der schnellste Einstieg. Die Starter-Vorlage enthält Beispielinhalte, eine OpenAPI-Spezifikation und Beispiele für jede Komponente. Sehen Sie sich an, wie alles funktioniert, und ersetzen Sie es dann durch Ihre eigenen Inhalte.

Option 2: Vorhandenes Repository verbinden

Sie haben bereits ein Repository mit für Jamdesk geeigneter Dokumentation? Verbinden Sie es direkt. Wenn Sie von Mintlify oder einer anderen Dokumentationsplattform kommen, verwenden Sie zuerst Option 3.

Option 3: Von Mintlify oder einer anderen Dokumentationsplattform migrieren

Ihre Dokumentation liegt bereits 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 und die manuellen Schritte für andere Dokumentationstools. Verbinden Sie danach das migrierte Repository gemäß 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 Seiten finden Sie unter Verzeichnisstruktur empfohlene Ordner, Assets und Snippets.

docs.json

Die Konfigurationsdatei, die Ihre Seite definiert:

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

Alle Konfigurationsoptionen finden Sie in der docs.json-Referenz.

MDX-Seiten

Dokumentationsseiten, geschrieben in MDX:

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

# Welcome

This is your first documentation page.

Frontmatter, Überschriften, Links und Komponentensyntax werden unter MDX-Grundlagen erklärt.

Lokale Entwicklung

Sehen Sie Änderungen lokal mit der Jamdesk CLI, bevor Sie zu GitHub pushen. Sie fängt MDX-Syntaxfehler ab, bevor sie Ihre Live-Seite erreichen. Alle Installationsmethoden und Befehle finden Sie in der Jamdesk-CLI-Übersicht.

Starten Sie sie:

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 zur docs.json hinzu:

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

3. Pushen Sie zu GitHub. Ihre neue Seite wird automatisch bereitgestellt.

Weitere Verlinkungsmuster, einschließlich Anker und Cards, finden Sie unter Links & Navigation.

Benutzerdefinierte Domain

Fügen Sie Ihre eigene Domain unter Settings → Domains 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ändige Anleitung →

Benötigen Sie Hilfe?

Im Hilfe-Center finden Sie Anleitungen zu Einrichtung, Abrechnung und Fehlerbehebung. Um eine Person zu erreichen, öffnen Sie das Chat-Widget in der unteren Ecke einer beliebigen Jamdesk-Seite oder schreiben Sie uns an support@jamdesk.com. Wir antworten schnell.

Vollständige Referenz

Die Referenzen behandeln jede MDX-Komponente, jeden CLI-Befehl und jede docs.json-Konfigurationsoption.

Wie geht es weiter?