Projekt-Setup im Überblick

Eine Jamdesk-Seite besteht aus einem Projekt im Dashboard, einem dahinterliegenden GitHub-Repo und einer docs.json-Datei, die deine Navigation beschreibt. Dieser Abschnitt behandelt dieses Setup. Lege URL-Struktur, Sprachen und Zugriffskontrolle früh fest. Sie lassen sich später nur schwer ändern, sobald du fünfzig Seiten hast.

Um von einer anderen Plattform zu wechseln, siehe den Migrationsleitfaden.

Vom Repository zur Live-Website

Projekt anlegen

Starte mit einer Vorlage oder verbinde ein bestehendes GitHub-Repo. Deine Seite ist danach unter yourproject.jamdesk.app erreichbar.

GitHub verbinden

Installiere die GitHub-App, damit jeder Push automatisch bereitgestellt wird.

Repo organisieren

Füge eine docs.json-Datei und MDX-Seiten hinzu.

Grundlegendes Setup

Projekt anlegen

Von einer Vorlage oder einem bestehenden Repo zur Live-Seite

GitHub verbinden

App-Installation, Repository-Zugriff und automatische Bereitstellung bei jedem Push

Verzeichnisstruktur

Erforderliche Dateien, Seitenverzeichnisse, Bilder und Snippets

Migrationsleitfaden

Wechsel von einer anderen Dokumentationsplattform, automatisiert oder manuell

Monorepo-Unterstützung

Dokumentation neben deinem Code halten, wenn sie nicht im Repo-Stammverzeichnis liegt

Mehrsprachige Unterstützung

Dokumentation in mehreren Sprachen mit einem Sprachumschalter ausliefern

Website-Struktur

Navigation

Tabs, Gruppen und Seiten, die deine Dokumentation ordnen

Weiterleitungen

Exakte und musterbasierte Weiterleitungen für verschobene oder umbenannte Seiten

Datenschutz und Zugriff

Zugriffskontrolle

Vollständig öffentlich, passwortgeschützt, gemischt oder SSO. Vergleiche die Optionen.

Passwortschutz

Die gesamte Seite oder einzelne Seiten hinter einem gemeinsamen Passwort sperren

Single Sign-On (SSO)

SAML oder OIDC über deinen Identity-Provider