---
title: End-to-End-Tutorial
description: "Vom leeren Repository zur live geschalteten Dokumentationsseite: Projekt erstellen, lokal prüfen, bereitstellen und optional eine eigene Domain konfigurieren."
---

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

Starten Sie mit einem leeren Repository und erstellen Sie eine live geschaltete Dokumentationsseite. Fügen Sie eine eigene Domain hinzu, sobald Sie bereit sind, und überspringen Sie bereits erledigte Schritte.

## Voraussetzungen

- Ein GitHub-Konto
- Ein Repository mit Dokumentationsinhalten (oder verwenden Sie die [Startervorlage](https://github.com/jamdesk/starter-docs))
- Node.js 20+, wenn Sie die CLI mit npm installieren möchten

<Steps>
  <Step title="Projekt erstellen und GitHub verbinden">
    Erstellen Sie Ihr erstes Projekt im Jamdesk-Dashboard und verbinden Sie ein Repository.

    - Folgen Sie [Projekte erstellen](/de/setup/creating-projects), um den Projektnamen, den Slug und den Dokumentationspfad festzulegen
    - Installieren Sie bei entsprechender Aufforderung die GitHub App und gewähren Sie Zugriff auf das Repository ([GitHub verbinden](/de/setup/connecting-github))
  </Step>

  <Step title="Seiten mit der CLI bearbeiten und in der Vorschau anzeigen">
    Verwenden Sie die Jamdesk CLI, um Seitenänderungen in der Vorschau anzuzeigen, bevor Sie sie an GitHub übertragen.

    <Tabs>
      <Tab title="npm">
        ```bash
        npm install -g jamdesk
        cd your-docs
        jamdesk dev
        ```
      </Tab>
      <Tab title="npx">
        ```bash
        cd your-docs
        npx jamdesk dev
        ```
      </Tab>
    </Tabs>

    Ihre lokale Vorschau läuft unter **http://localhost:3000**. Weitere Informationen finden Sie unter [Lokale Vorschau](/de/development/local-preview).

    Öffnen Sie eine `.mdx`-Seite in Ihrem Editor, speichern Sie eine Änderung und aktualisieren Sie die lokale Vorschau. Wenn alles richtig aussieht, veröffentlichen Sie die Änderung im nächsten Schritt mit dem Git-Workflow.
  </Step>

  <Step title="Durch Übertragen an GitHub bereitstellen">
    Jeder Push in Ihren konfigurierten Branch löst einen Build aus und veröffentlicht Ihre Dokumentation auf Ihrer Jamdesk-Subdomain.

    ```bash
    git add .
    git commit -m "Add docs content"
    git push origin main
    ```

    Ersetzen Sie `main` durch den in Ihrem Projekt konfigurierten Branch, wenn Sie einen anderen Branch verwenden.

    Nach Abschluss des Builds ist Ihre Dokumentation unter `your-project.jamdesk.app` live geschaltet. Weitere Informationen finden Sie unter [Bereitstellung](/de/development/deployment).
  </Step>

  <Step title="Optional: Eigene Domain hinzufügen">
    Stellen Sie Ihre Dokumentation über Ihre eigene Domain statt über die Jamdesk-Subdomain bereit.

    1. Gehen Sie im Jamdesk-Dashboard zu **Settings** → **Domains**
    2. Fügen Sie Ihre Domain hinzu (zum Beispiel `docs.example.com`)
    3. Erstellen Sie die im Dashboard angezeigten DNS-Einträge
    4. Warten Sie, bis die Verifizierung und SSL abgeschlossen sind

    Informationen zur Fehlerbehebung finden Sie unter [Eigene Domains](/de/deploy/custom-domains).
  </Step>
</Steps>

## End-to-End-Ablauf überprüfen

- Ihre Jamdesk-Subdomain wird geladen und zeigt den neuesten Build
- Die lokale Vorschau enthält dieselben Inhalte und dieselbe Navigation
- Falls konfiguriert, ist die eigene Domain verifiziert und stellt HTTPS bereit
- Die Build-Historie zeigt den neuesten Commit und die Zuordnung zum Autor

## Optional: Unter /docs hosten

Wenn Sie Ihre Dokumentation unter einem Unterpfad wie `example.com/docs` bereitstellen möchten, lesen Sie [Übersicht zur Bereitstellung](/de/deploy/overview) und [Hosting unter einem Unterpfad](/de/deploy/subpath-hosting).

## Wie geht es weiter?

<Columns cols={2}>
  <Card title="Projekt erstellen" icon="plus" href="/de/setup/creating-projects">
    Projekteinstellungen und Vorlagen verwalten
  </Card>
  <Card title="CLI-Übersicht" icon="terminal" href="/de/cli/overview">
    CLI installieren und verfügbare Befehle anzeigen
  </Card>
  <Card title="Übersicht zur Bereitstellung" icon="cloud-arrow-up" href="/de/deploy/overview">
    Hosting-Optionen vergleichen
  </Card>
  <Card title="Eigene Domains" icon="globe" href="/de/deploy/custom-domains">
    DNS überprüfen und Einrichtung beheben
  </Card>
</Columns>