Konfigurieren Sie Mintlify so, dass die Dokumentation aus einem bestimmten Verzeichnis innerhalb eines Monorepos bereitgestellt wird. Dieses Setup ermöglicht es Ihnen, die Dokumentation zusammen mit Ihrem Code in Repositories zu verwalten, die mehrere Projekte oder Services enthalten.

Voraussetzungen

  • Administratorzugriff auf Ihr Mintlify-Projekt.
  • Dokumentationsdateien, die in einem eigenen Verzeichnis innerhalb Ihres Monorepos organisiert sind.
  • Eine gültige docs.json in Ihrem Dokumentationsverzeichnis.

Monorepo-Bereitstellung konfigurieren

1

Git-Einstellungen öffnen

Navigieren Sie in Ihrem Dashboard zu Git Settings.
Das Projekteinstellungs-Panel im Menü Git Settings. Der Schalter Set up as monorepo ist aktiviert und ein Pfad zum Verzeichnis /docs ist angegeben.
2

Dokumentationspfad festlegen

  1. Aktivieren Sie den Schalter Set up as monorepo.
  2. Geben Sie den relativen Pfad zu Ihrem Docs-Verzeichnis ein. Befinden sich Ihre Docs beispielsweise im Verzeichnis docs, geben Sie /docs ein.
Fügen Sie am Ende des Pfads keinen abschließenden Schrägstrich hinzu.
  1. Klicken Sie auf Save changes.