---
title: "Schnellstart: In 5 Minuten bereitstellen"
sidebarTitle: Schnellstart
description: "Erstellen Sie eine Jamdesk-Dokumentationsseite und stellen Sie sie auf Ihrer Subdomain bereit – nur mit GitHub und zwei Dateien."
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

**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](https://github.com)-Konto
- Ein Repository mit Ihrer Dokumentation (oder wir erstellen eines)

## Option 1: Mit der Startervorlage beginnen

Der schnellste Weg zum Einstieg. Die [Startervorlage](https://github.com/jamdesk/starter-docs) 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.

<Steps>
  <Step title="Jamdesk-Konto erstellen">
    Öffnen Sie [dashboard.jamdesk.com](https://dashboard.jamdesk.com) und registrieren Sie sich mit GitHub.
  </Step>

  <Step title="Projekt aus Vorlage erstellen">
    Klicken Sie auf **New Project** → **From Template** → **Starter Docs**.

    Jamdesk erstellt ein GitHub-Repository für Sie, in dem alles vorkonfiguriert ist.
  </Step>

  <Step title="Ihre Seite ist live">
    Ihre Dokumentation wird unter `your-project.jamdesk.app` bereitgestellt. Bearbeiten Sie die MDX-Dateien und übertragen Sie sie per Push – die Seite wird automatisch neu erstellt.
  </Step>
</Steps>

<Tip>
Sie können die Startervorlage auch direkt klonen: `git clone https://github.com/jamdesk/starter-docs.git my-docs`
</Tip>

<Tip>
**Möchten Sie einige Seiten privat halten?** Fügen Sie der Frontmatter jeder beliebigen MDX-Datei `private: true` hinzu und legen Sie nach dem nächsten Build unter **Project Settings** ein Passwort fest. Unter [Zugriffskontrolle](/de/setup/access-control) finden Sie alle vier Optionen (öffentlich, Passwort für die gesamte Seite, gemischt, SSO).
</Tip>

## 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.

<Steps>
  <Step title="Jamdesk-Konto erstellen">
    Öffnen Sie [dashboard.jamdesk.com](https://dashboard.jamdesk.com) und registrieren Sie sich mit GitHub.
  </Step>

  <Step title="Projekt erstellen">
    Klicken Sie auf **New Project** und verbinden Sie Ihr Repository.

    1. Wählen Sie Ihr GitHub-Repository aus
    2. Wählen Sie den bereitzustellenden Branch aus
    3. Jamdesk erkennt Ihre `docs.json` automatisch

    Wenn Ihr Repository noch keine `docs.json` enthält, fügen Sie vor dem Verbinden die minimale Datei aus [Was enthält ein Docs-Projekt](#was-enthält-ein-docs-projekt) hinzu.

    Informationen zu Repository-Berechtigungen, Branch-Auswahl und Dokumentationspfaden finden Sie unter [GitHub verbinden](/de/setup/connecting-github).
  </Step>

  <Step title="Ihre Seite ist live">
    Ihre Dokumentation wird unter `your-project.jamdesk.app` bereitgestellt. Dabei wird `llms.txt` automatisch generiert, damit KI-Tools Ihre Dokumentation lesen können.

    Jeder Push auf Ihren verbundenen Branch löst automatisch einen neuen Build aus.
  </Step>
</Steps>

## 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](#option-2-vorhandenes-repository-verbinden).

<Columns cols={2}>
  <Card title="Migrationsleitfaden" icon="right-left" href="/de/setup/migration">
    Mintlify-Dokumentation konvertieren oder manuell von einer anderen Dokumentationsplattform migrieren
  </Card>
</Columns>

## Was enthält ein Docs-Projekt

Ein minimales Jamdesk-Projekt besteht aus zwei Dingen:

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

Für größere Websites finden Sie unter [Verzeichnisstruktur](/de/setup/directory-structure) empfohlene Ordner, Assets und Snippets.

### docs.json

Die Konfigurationsdatei, die Ihre Website definiert:

```json
{
  "$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](/de/config/docs-json-reference).

### MDX-Seiten

Dokumentationsseiten, die in MDX verfasst sind:

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

# Welcome

This is your first documentation page.
```

Unter [MDX-Grundlagen](/de/content/mdx-basics) 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](https://jamdesk.com/docs/cli/overview).

Änderungen lokal in der Vorschau anzeigen:

<Tabs>
  <Tab title="npm">
    ```bash
    npm install -g jamdesk
    cd my-docs
    jamdesk dev
    ```
  </Tab>
  <Tab title="Homebrew">
    ```bash
    brew tap jamdesk/tap
    brew install jamdesk
    cd my-docs
    jamdesk dev
    ```
  </Tab>
  <Tab title="npx">
    ```bash
    cd my-docs
    npx jamdesk dev
    ```
  </Tab>
</Tabs>

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

## Weitere Seiten hinzufügen

1. Erstellen Sie eine neue MDX-Datei:

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

Your content here...
```

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

```json docs.json
{
  "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](/de/content/links).

## 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 →](/de/deploy/custom-domains)

## Benötigen Sie Hilfe?

Kommen Sie bei etwas nicht weiter? Durchsuchen Sie das [Help Center](/de/help/overview) 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](mailto: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](/de/components/overview), jeder [CLI-Befehl](/de/cli/overview) und jede [`docs.json`-Konfigurationsoption](/de/config/docs-json-reference).

## Wie geht es weiter?

<Columns cols={2}>
  <Card title="End-to-End-Tutorial" icon="route" href="/de/end-to-end-tutorial">
    Vollständiger Workflow von der Einrichtung bis zur benutzerdefinierten Domain
  </Card>
  <Card title="MDX-Grundlagen" icon="file-code" href="/de/content/mdx-basics">
    Dokumentation in MDX verfassen
  </Card>
  <Card title="Komponenten" icon="puzzle-piece" href="/de/components/overview">
    Verfügbare Komponenten erkunden
  </Card>
  <Card title="Konfigurationsreferenz" icon="gear" href="/de/config/docs-json-reference">
    Alle docs.json-Optionen
  </Card>
</Columns>