Ein Projekt erstellen

Bevor Sie Dokumentation schreiben können, benötigen Sie ein Projekt. Sie können mit einer Vorlage beginnen (Jamdesk erstellt das GitHub-Repository für Sie) oder ein vorhandenes Repository verbinden, das bereits eine docs.json enthält. In beiden Fällen ist Ihre Website innerhalb weniger Minuten live.

Ein neues Projekt erstellen

Click New Project

Klicken Sie im Dashboard oben rechts auf New Project.

Einen Ausgangspunkt auswählen

Beginnen Sie mit einer vorgefertigten Vorlage. Jamdesk erstellt für Sie ein neues GitHub-Repository mit Beispielinhalten, Navigation und bereits konfigurierten Komponenten.

Die standardmäßige Starter Template enthält Beispielseiten, eine OpenAPI-Spezifikation und Beispiele für jede Komponente. Ersetzen Sie die Inhalte durch Ihre eigenen, und schon sind Sie fertig.

Projekteinstellungen konfigurieren

Legen Sie die grundlegenden Informationen Ihres Projekts fest:

Field	Description
Name	Im Dashboard angezeigter Anzeigename
Slug	URL-freundlicher Bezeichner (z. B. `my-docs`)
Domain	Ihre `*.jamdesk.app`-Subdomain

Minimale Repository-Struktur

Ein Jamdesk-Projekt benötigt nur eine docs.json und mindestens eine Seite:

my-docs/
├── docs.json
└── introduction.mdx

Beispiel für docs.json:

docs.json

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

Projekteinstellungen

Konfigurieren Sie Ihr Projekt nach der Erstellung unter Settings:

Allgemein

Name – Aktualisieren Sie den Anzeigenamen
Slug – Ändern Sie den Projektbezeichner
Delete Project – Entfernen Sie das Projekt dauerhaft

Repository

Branch – Der Branch, der Bereitstellungen auslöst
Docs Path – Speicherort von docs.json in Monorepos

Domain

Subdomain – Ihre *.jamdesk.app-URL
Custom Domain – Fügen Sie Ihre eigene Domain hinzu
Host at a subpath – Stellen Sie die Dokumentation unter einem Pfad wie /docs oder /help statt im Stammverzeichnis der Website bereit

Build

Show Jamdesk Branding – Zeigen Sie den Link „Powered by Jamdesk“ in der Fußzeile an (standardmäßig aktiviert)
Rebuild – Lösen Sie manuell einen neuen Build aus

Änderungen an den Build-Einstellungen werden erst mit einem neuen Build wirksam.

Projektlimits

Plan	Projects	Builds/Month
Free	1	100
Pro	10	Unlimited
Team	Unlimited	Unlimited

Wie geht es weiter?

GitHub verbinden

Verbinden Sie Ihr Repository für automatische Builds

Verzeichnisstruktur

Organisieren Sie Ihre Dokumentation für eine skalierbare Struktur

Monorepo einrichten

Konfigurieren Sie den Dokumentationspfad für Monorepos

End-to-End-Tutorial

Folgen Sie dem vollständigen Jamdesk-Workflow