Projekt-Setup-Übersicht

Jede Jamdesk-Website beginnt auf dieselbe Weise: mit einem Projekt im Dashboard, einem dahinterliegenden GitHub-Repository und einer docs.json-Datei, die Ihre Navigation beschreibt. Dieser Abschnitt behandelt diese anfängliche Einrichtung sowie strukturelle Entscheidungen, die Sie frühzeitig treffen sollten. URL-Struktur, Sprachen und Zugriffskontrolle lassen sich deutlich einfacher festlegen, bevor Sie fünfzig Seiten haben.

Sie migrieren von einer anderen Plattform? Springen Sie direkt zum Migrationsleitfaden. Jamdesk kann den Großteil der Konvertierung automatisieren.

Vom Repository zur Live-Website

Projekt erstellen

Beginnen Sie mit einer Vorlage oder verbinden Sie ein vorhandenes GitHub-Repository. Ihre Website wird unter yourproject.jamdesk.app live geschaltet.

GitHub verbinden

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

Repository organisieren

Eine docs.json-Datei und MDX-Seiten. Das ist der gesamte Vertrag.

Grundlegendes Setup

Projekt erstellen

Von einer Vorlage oder einem vorhandenen Repository zur Live-Website

GitHub verbinden

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

Verzeichnisstruktur

Erforderliche Dateien, Seitenverzeichnisse, Bilder und Snippets

Migrationsleitfaden

Wechsel von einer anderen Dokumentationsplattform, automatisiert oder manuell

Monorepo-Unterstützung

Bewahren Sie Ihre Dokumentation zusammen mit Ihrem Code auf, wenn sie nicht im Stammverzeichnis des Repositorys liegt

Unterstützung mehrerer Sprachen

Stellen Sie Dokumentation in mehreren Sprachen mit einem Sprachumschalter bereit

Website-Struktur

Navigation

Tabs, Gruppen und Seiten, die Ihre Dokumentation organisieren

Weiterleitungen

Exakte und musterbasierte Weiterleitungen für verschobene oder umbenannte Seiten

Datenschutz und Zugriff

Zugriffskontrolle

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

Passwortschutz

Sperren Sie die gesamte Website oder nur einige wenige Seiten mit einem gemeinsamen Passwort

Single Sign-On (SSO)

SAML oder OIDC über Ihren Identitätsanbieter