Monorepo-Unterstützung
Aktiviere den Monorepo-Modus in den Jamdesk-Projekteinstellungen und gib den Pfad zum Docs-Verzeichnis an, damit nur deine Dokumentation erstellt wird.
Wenn sich deine docs.json in einem Unterverzeichnis befindet (docs/, packages/docs/ oder einem anderen Verzeichnis), aktiviere den Monorepo-Modus in den Projekteinstellungen und gib den Pfad an. Jamdesk erstellt nur Inhalte aus diesem Verzeichnis.
Die Screenshots zeigen die Benutzeroberfläche auf Englisch.
Voraussetzungen: Du benötigst ein Jamdesk-Projekt, das mit einem GitHub-Repository verbunden ist, bevor du die Monorepo-Unterstützung konfigurierst.
So beschränkt Jamdesk Ihren Build
Schnelle Einrichtung
Öffne dein Projekt im Jamdesk-Dashboard und gehe zu Settings.
Aktiviere im Abschnitt Git Repository die Option Set up as monorepo.
Gib den Pfad zum Verzeichnis ein, das deine docs.json-Datei enthält.
In der Vorschau siehst du, wo Jamdesk nach deiner Konfigurationsdatei sucht.
Klicke auf Save Changes. Beim nächsten Build wird der neue Pfad verwendet.
Den Docs-Pfad verstehen
Gib nur den Verzeichnispfad ein, nicht den Dateinamen. Verwende docs statt docs/docs.json.
Pfadbeispiele
| Repository-Struktur | Wert für den Docs-Pfad |
|---|---|
my-repo/docs/docs.json | docs |
my-repo/packages/docs/docs.json | packages/docs |
my-repo/apps/website/docs/docs.json | apps/website/docs |
my-repo/documentation/docs.json | documentation |
Was eingeschlossen wird
Jamdesk verarbeitet nur Dateien innerhalb des Docs-Pfads:
- Inhaltsdateien (
.mdx,.md) werden zu Seiten kompiliert - Assets in Unterverzeichnissen (z. B.
images/) werden einbezogen - Konfiguration (
docs.json) definiert deine Website
Dateien außerhalb des Docs-Pfads werden bei Builds ignoriert.
Gängige Monorepo-Muster
Dokumentation in einem Verzeichnis auf oberster Ebene.
monorepo/
├── packages/
├── apps/
└── docs/ # Docs path: docs
├── docs.json
├── introduction.mdx
└── guides/Docs-Pfad: docs
Mit Assets arbeiten
Asset-Pfade in docs.json beziehen sich immer auf dein Docs-Verzeichnis, nicht auf das Repository-Stammverzeichnis.
Beispiel
Bei Docs in packages/docs/:
{
"logo": {
"light": "/images/logo.svg"
},
"favicon": "/images/favicon.svg"
}Diese Pfade verweisen auf:
packages/docs/images/logo.svgpackages/docs/images/favicon.svg
Verwende keine absoluten Pfade vom Repository-Stammverzeichnis. Das funktioniert nicht:
"favicon": "/packages/docs/images/favicon.svg"In MDX-Dateien
Für Bilder in MDX gilt dieselbe Regel:
Der Verweis führt zu einem Bild unter [docs-path]/images/tabs-preview.png.
Interne Links
Interne Links hängen nicht von deiner Repository-Struktur ab. Verwende Pfade relativ zum Docs-Stammverzeichnis:
[See the quickstart guide](/quickstart)
[Installation steps](/quickstart#installation)Diese Pfade entsprechen deiner Navigationsstruktur, nicht deinem Dateisystem.
Build-Verhalten
Nur Änderungen innerhalb des Docs-Pfads lösen einen Build aus:
- Änderungen an
packages/docs/**lösen einen Build aus - Änderungen an
packages/core/**lösen keinen Build aus
Muss bei Änderungen an anderem Code ein neuer Build erstellt werden?
Wenn deine Docs aus Quellcode generiert werden (z. B. API-Dokumentation aus Codekommentaren), starte einen manuellen Build über das Dashboard oder richte einen Webhook in deiner CI-Pipeline ein.
Kompatibilität mit Workspace-Tools
Lege den Docs-Pfad fest. Für diese Monorepo-Tools ist keine weitere Konfiguration erforderlich.
| Tool | Unterstützt |
|---|---|
| npm workspaces | Ja |
| Yarn workspaces | Ja |
| pnpm workspaces | Ja |
| Turborepo | Ja |
| Nx | Ja |
| Lerna | Ja |
Fehlerbehebung
- Prüfe, ob der genaue Pfad in deinem Repository mit deiner Eingabe übereinstimmt
- Stelle sicher, dass
docs.jsonan diesem Speicherort vorhanden ist - Prüfe die Schreibweise. Bei Pfaden wird zwischen Groß- und Kleinschreibung unterschieden
- Denke daran: Verwende
docsstattdocs/docs.json
Schnellprüfung: Die Datei sollte sich in deinem Repository unter [your-docs-path]/docs.json befinden.
Asset-Pfade müssen relativ zu deinem Docs-Verzeichnis sein.
Richtig (relativ zum Docs-Verzeichnis):
"favicon": "/images/favicon.svg"Falsch (absoluter Pfad vom Repository-Stammverzeichnis):
"favicon": "/packages/docs/images/favicon.svg"Prüfe, ob deine Bilder unter [docs-path]/images/ vorhanden sind.
Nur Änderungen innerhalb des Docs-Pfads lösen automatische Builds aus.
- Prüfe, ob du Dateien innerhalb des Docs-Pfads änderst
- Stelle sicher, dass du in den richtigen Branch pushst
- Prüfe den Zustellungsstatus von Webhooks in den GitHub-Repository-Einstellungen
Um bei Änderungen außerhalb des Docs-Pfads einen Build auszulösen, starte manuelle Builds oder verwende CI-Webhooks.