Build-Fehlerreferenz
Alle Build-Fehlercodes mit Ursache und Lösung für Konfiguration, MDX-Syntax, OpenAPI, Timeouts und Assets.
Finde deinen Fehlercode mit Ctrl/Cmd+F oder durchsuche die Kategorien: Konfiguration, MDX, OpenAPI, Timeouts und Assets.
Konfigurationsfehler
INVALID_DOCS_JSON
Nachricht: "Invalid docs.json configuration"
Ursache: Deine Datei docs.json enthält Syntaxfehler oder ungültige Werte.
Lösung:
- Führe lokal
jamdesk validateaus, um detaillierte Fehler anzuzeigen - Prüfe auf fehlende Kommas, Klammern oder Anführungszeichen
- Stelle sicher, dass alle Werte dem erwarteten Schema entsprechen
MISSING_PAGE
Nachricht: "Page 'path/to/page' referenced in navigation but file not found"
Ursache: Eine in der Navigation von docs.json aufgeführte Seite existiert nicht.
Lösung:
- Prüfe, ob die Datei am angegebenen Pfad vorhanden ist
- Stelle sicher, dass der Pfad in
docs.jsonmit dem tatsächlichen Dateinamen übereinstimmt (ohne.mdx) - Bei Pfaden wird zwischen Groß- und Kleinschreibung unterschieden. Prüfe daher die Schreibweise
INVALID_FRONTMATTER
Nachricht: "Invalid frontmatter in 'path/to/page'"
Ursache: Das YAML-Frontmatter am Anfang einer MDX-Datei ist fehlerhaft.
Lösung:
- Stelle sicher, dass das Frontmatter mit
---beginnt und endet - Prüfe auf ungültige YAML-Syntax (fehlende Doppelpunkte, falsche Einrückung)
- Setze Zeichenketten mit Sonderzeichen in Anführungszeichen
MDX-Fehler
MDX_SYNTAX_ERROR
Nachricht: "MDX compilation failed"
Ursache: Ungültige MDX- oder JSX-Syntax in deinem Inhalt.
Lösung:
- Stelle sicher, dass alle JSX-Tags korrekt geschlossen werden (
<Card>...</Card>) - Prüfe, ob Props die korrekte Syntax verwenden (
title="value"statttitle=value) - Maskiere geschweifte Klammern in normalem Text:
\{statt{
COMPONENT_NOT_FOUND
Nachricht: "Unknown component 'ComponentName'"
Ursache: Du verwendest eine Komponente, die in Jamdesk nicht existiert.
Lösung:
- Prüfe die Komponentenreferenz auf die korrekten Namen
- Bei Komponentennamen wird zwischen Groß- und Kleinschreibung unterschieden: Verwende
<Card>statt<card> - Stelle sicher, dass du keine benutzerdefinierten Komponenten importierst (nicht unterstützt)
INVALID_PROPS
Nachricht: "Invalid props for component 'ComponentName'"
Ursache: Eine Komponente hat Props erhalten, die sie nicht akzeptiert.
Lösung:
- Prüfe die Komponentendokumentation auf gültige Props
- Entferne nicht unterstützte Props
- Prüfe den erwarteten Typ der Prop in der Komponentendokumentation (beispielsweise erwartet
colseine Zahl und keine Zeichenkette)
OpenAPI-Fehler
OPENAPI_PARSE_ERROR
Nachricht: "Failed to parse OpenAPI specification"
Ursache: Deine OpenAPI-Spezifikationsdatei enthält eine ungültige Syntax oder Struktur.
Lösung:
- Führe lokal
jamdesk openapi-checkaus, um die Datei zu validieren - Verwende einen OpenAPI-Validator wie Swagger Editor
- Prüfe auf eine gültige JSON- oder YAML-Syntax
OPENAPI_REFERENCE_ERROR
Nachricht: "Unresolved reference in OpenAPI spec"
Ursache: Ein $ref in deiner OpenAPI-Spezifikation verweist auf eine nicht vorhandene Definition.
Lösung:
- Prüfe, ob alle
$ref-Pfade korrekt sind - Stelle sicher, dass die referenzierten Schemas unter
components/schemasexistieren - Wenn ein
$refauf eine externe Datei oder URL verweist, bestätige, dass die Datei in deinem Projekt enthalten und die URL erreichbar ist
Build-Timeout
BUILD_TIMEOUT
Nachricht: "Build exceeded maximum time limit"
Ursache: Der Build dauerte länger als die zulässige Zeit (normalerweise 5 Minuten).
Lösung:
- Optimiere große Bilder (komprimiere sie oder ändere ihre Größe)
- Teile sehr große Seiten in kleinere Seiten auf
- Reduziere die Seitenanzahl, wenn sie extrem groß ist
- Wende dich an den Support, wenn das Problem weiterhin besteht
Asset-Fehler
ASSET_NOT_FOUND
Nachricht: "Asset 'path/to/asset' not found"
Ursache: Ein in deiner Dokumentation referenziertes Bild oder eine Datei existiert nicht.
Lösung:
- Prüfe, ob die Datei am angegebenen Pfad vorhanden ist
- Stelle sicher, dass der Pfad relativ zu deinem Dokumentationsverzeichnis ist
- Bei Pfaden wird zwischen Groß- und Kleinschreibung unterschieden. Prüfe daher den Dateinamen exakt
ASSET_TOO_LARGE
Nachricht: "Asset exceeds maximum file size"
Ursache: Ein Bild oder eine Datei ist größer als das Limit von 10 MB.
Lösung:
- Komprimiere Bilder mit Tools wie TinyPNG oder ImageOptim
- Verwende geeignete Formate (WebP für Fotos, SVG für Symbole)
- Erwäge, sehr große Dateien extern zu hosten
Hilfe erhalten
Wenn du einen Fehler nicht beheben kannst:
- Prüfe das vollständige Build-Protokoll in deinem Dashboard auf weitere Informationen
- Durchsuche die FAQ nach häufigen Problemen
- Kontaktiere den Support mit deiner Projekt-ID und den Fehlerdetails
