Die Datei docs.json ermöglicht es dir, eine Sammlung von Markdown-Dateien in eine navigierbare, individuell angepasste Dokumentationswebsite zu verwandeln. Diese erforderliche Konfigurationsdatei steuert Styling, Navigation, Integrationen und mehr. Denk daran als den Bauplan für deine Dokumentation. Einstellungen in docs.json gelten global für alle Seiten.

​
Einrichten Ihrer docs.json

Für den Einstieg müssen Sie nur theme, name, colors.primary und navigation angeben. Alle anderen Felder sind optional und können hinzugefügt werden, wenn der Bedarf Ihrer Dokumentation wächst. Für das beste Bearbeitungserlebnis fügen Sie die Schema-Referenz oben in Ihrer docs.json-Datei ein. Dadurch werden Autovervollständigung, Validierung und hilfreiche Tooltips in den meisten Code-Editoren aktiviert: 
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Your Docs",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": {
    // Ihre Navigationsstruktur
  }
  // Der Rest Ihrer Konfiguration
}

​
Referenz

Dieser Abschnitt enthält die vollständige Referenz zur Datei docs.json.

​
Anpassung

​
theme
required
Das Layout-Theme Ihrer Site.Eines der folgenden: mint, maple, palm, willow, linden, almond, aspen.Siehe Themes für weitere Informationen.
​
name
string
required
Der Name Ihres Projekts, Ihrer Organisation oder Ihres Produkts.
​
colors
object
required
Die in Ihrer Dokumentation verwendeten Farben. Farben werden je nach Theme unterschiedlich angewendet. Wenn Sie nur eine Primärfarbe angeben, wird sie für alle Farbelemente verwendet.
​
description
string
Beschreibung Ihrer Site für SEO und KI-Indexierung.
Ihr Logo für den hellen und den dunklen Modus.
​
favicon
string or object
Pfad zu Ihrer Favicon-Datei einschließlich Dateierweiterung. Wird automatisch auf passende Favicon-Größen skaliert. Kann eine einzelne Datei oder separate Dateien für hellen und dunklen Modus sein. Beispiel: /favicon.png
​
thumbnails
object
Thumbnail-Anpassung für soziale Medien und Seitenvorschauen.
​
styling
object
Konfigurationen für das visuelle Styling.
​
icons
object
Einstellungen für die Icon-Bibliothek.
​
fonts
object
Schriftkonfiguration für Ihre Dokumentation. Die Standardschrift ist Inter.
​
appearance
object
Einstellungen für den Umschalter Hell-/Dunkelmodus.
​
background
object
Einstellungen für Hintergrundfarbe und -dekoration.

​
Struktur

​
navbar
object
Elemente der Navigationsleiste.
​
navigation
object
required
Die Navigationsstruktur Ihrer Inhalte.
​
interaction
object
Einstellungen für die Benutzerinteraktion bei Navigationselementen.
​
footer
object
Footer-Inhalt und Social-Media-Links.
​
banner
object
Websiteweiter Banner, der oben auf den Seiten angezeigt wird.
​
redirects
array of object
Weiterleitungen für verschobene, umbenannte oder gelöschte Seiten.
​
contextual
object
Kontextmenü für KI-optimierte Inhalte und Integrationen.

​
API-Konfigurationen

​
api
object
Einstellungen für API-Dokumentation und interaktive Spielwiese.
​
seo
object
SEO-Indexierungskonfigurationen.
​
search
object
Anzeigeeinstellungen für die Suche.

​
Integrationen

​
integrations
object
Integrationen von Drittanbietern.

​
Fehler

​
errors
object
Einstellungen für die Fehlerbehandlung.

​
Beispiele

docs.json
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. ist ein Unternehmen, das Beispielinhalte und Platzhaltertext bereitstellt.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Dokumentation",
        "icon": "book",
        "description": "So verwenden Sie das Produkt von Example Co.",
        "groups": [
          {
            "group": "Erste Schritte",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "Anpassung",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "Abrechnung",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "Änderungsprotokoll",
        "icon": "history",
        "description": "Updates und Änderungen",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Community",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Loslegen",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Ressourcen",
        "items": [
          {
            "label": "Kunden",
            "href": "https://example.com/customers"
          },
          {
            "label": "Enterprise",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Vorschau anfordern",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Unternehmen",
        "items": [
          {
            "label": "Karriere",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Datenschutzerklärung",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "koala": {
      "publicApiKey": "pk_example_key_123"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "Nicht gefunden",
      "description": "Was ist nur mit dieser **Seite** _passiert_?"
    }
  }
}

​
Upgrade von mint.json

Wenn Ihr Docs-Projekt die veraltete Datei mint.json verwendet, folgen Sie diesen Schritten, um auf docs.json zu aktualisieren.
1

CLI installieren oder aktualisieren

Wenn Sie die CLI noch nicht installiert haben, installieren Sie sie jetzt:
npm i -g mint
Wenn die CLI bereits installiert ist, stellen Sie sicher, dass sie aktuell ist:
mint update
2

docs.json-Datei erstellen

Führen Sie in Ihrem Docs-Repository Folgendes aus:
mint upgrade
Dieser Befehl erstellt aus Ihrer vorhandenen mint.json eine docs.json-Datei. Überprüfen Sie die generierte Datei, um sicherzustellen, dass alle Einstellungen korrekt sind.
3

mint.json-Datei löschen

Nachdem Sie überprüft haben, dass Ihre docs.json korrekt konfiguriert ist, können Sie die alte mint.json-Datei sicher löschen.