Verwende den Dateiexplorer in der Seitenleiste, um deine Dokumentationsdateien zu durchsuchen. Klicke auf eine Datei, um sie im Editor zu öffnen. Drücke Command + P (Strg + P unter Windows), um Dateien nach Namen zu suchen.

​
Neue Seiten erstellen

1

Neue Datei erstellen

Wähle in der Dateiexplorer-Seitenleiste das Symbol Neue Datei erstellen aus.Dateimenü im Web-Editor
2

Dateinamen eingeben

Dateinamen müssen auf .mdx enden. Zum Beispiel api-reference.mdx oder getting-started.mdx.
3

Erstellen und öffnen

Drücke Enter, um die Datei zu erstellen. Sie wird automatisch im Editor geöffnet und ist bereit für das Hinzufügen von Inhalten.
Fügen Sie neue Seiten zur Navigation Ihrer Site hinzu, indem Sie die Datei docs.json bearbeiten.
1

docs.json öffnen

Suchen und öffnen Sie die Datei docs.json in Ihrem Root-Verzeichnis mit dem Dateiexplorer.
2

Navigationsabschnitt finden

Suchen Sie die Stelle in der Datei docs.json, an der Sie Ihre neue Seite hinzufügen möchten.
3

Seite hinzufügen

Fügen Sie den Dateinamen Ihrer Seite (ohne die .mdx-Erweiterung) im pages-Array der entsprechenden Gruppe ein.

​
Beispiel: Hinzufügen einer Themes-Seite

Hinzufügen einer Themes-Seite zur Gruppe Profile
{
    "navigation": {
        "groups": [
            {
                "group": "Getting started",
                "pages": [
                    "index",
                    "quickstart", 
                    "installation"
                ]
            },
            {
                "group": "Profile",
                "pages": [
                    "settings",
                    "account-types", 
                    "dashboard",
                    "themes"
                ]
            }
        ]
    }
}

​
Inhalte bearbeiten

Nehmen Sie Änderungen an Ihren Seiten im visuellen Modus oder im Markdown-Modus im Editor vor. Drücken Sie im visuellen Modus /, um das Komponentenmenü zu öffnen. Fügen Sie Inhaltsblöcke, Hinweise, Codeblöcke und andere Komponenten hinzu, um Ihre Dokumentation anzupassen.
Das ausgeklappte Komponentenmenü im Mintlify Web-Editor
Im Markdown-Modus können Sie das MDX Ihrer Seiten direkt bearbeiten. Das ist hilfreich, wenn Sie Folgendes benötigen:
  • Bestimmte Eigenschaften von Komponenten festlegen
  • Mit komplex verschachtelten Komponenten arbeiten
  • MDX-Inhalte aus anderen Quellen kopieren und einfügen