Erste Schritte mit dem Web-Editor

Erfahren Sie, wie Sie mit dem Web-Editor Dokumentationen erstellen und bearbeiten

Der Web-Editor ist eine visuelle Oberfläche zum Erstellen, Bearbeiten und Prüfen von Dokumentationen direkt im Browser.

• Visuelles Bearbeiten: Nehmen Sie Änderungen mit einem WYSIWYG-Editor (What You See Is What You Get) vor, der zeigt, wie Ihre Inhalte nach der Veröffentlichung aussehen.
• Git-Synchronisierung: Alle Änderungen werden automatisch mit Ihrem Git-Repository synchronisiert, um die Versionskontrolle sicherzustellen.
• Teamzusammenarbeit: Mehrere Personen können gleichzeitig an der Dokumentation arbeiten.
• Komponentenintegration: Fügen Sie Callouts, Codeblöcke und andere Komponenten per Slash-Befehl hinzu.
• Keine Einrichtung erforderlich: Beginnen Sie direkt vom Dashboard aus mit dem Schreiben.

Web-Editor-Workflow

So arbeiten Sie typischerweise im Web-Editor:

1. Wählen Sie Ihren Branch

   Erstellen Sie einen Branch oder nehmen Sie Änderungen direkt an Ihrem Deployment-Branch vor. Wir empfehlen, einen Branch zu erstellen, damit Sie Ihre Änderungen in der Vorschau sehen können, bevor sie live gehen.

2. Öffnen Sie Ihre Datei

   Navigieren Sie in der Seitenleiste zu einer vorhandenen Datei oder erstellen Sie eine neue über den Dateiexplorer.

3. Bearbeiten Sie Ihren Inhalt

   Nehmen Sie Änderungen im Web-Editor vor. Wechseln Sie über den Schalter oben rechts zwischen dem visuellen Modus und dem Markdown-Modus, um herauszufinden, welchen Modus Sie bevorzugen.

4. Änderungen in der Vorschau ansehen

   Der visuelle Modus zeigt, wie Ihre Änderungen auf Ihrer Live-Website erscheinen. Nutzen Sie ihn, um zu prüfen, ob alles korrekt aussieht.

5. Änderungen veröffentlichen

   Wenn Sie in Ihrem Deployment-Branch arbeiten, veröffentlichen Sie Ihre Änderungen direkt aus dem Web-Editor. In anderen Branches erstellen Sie vor der Veröffentlichung eine Pull-Request zur Überprüfung.

Editor-Modi

Der Web-Editor bietet zwei Modi, um unterschiedlichen Vorlieben und Anforderungen beim Bearbeiten gerecht zu werden. Verwenden Sie den Schalter in der oberen rechten Ecke der Editor-Symbolleiste, um zwischen den Bearbeitungsmodi zu wechseln.

Visueller Modus

Der visuelle Modus bietet eine WYSIWYG-Umgebung, in der die Änderungen, die Sie im Editor vornehmen, genau so veröffentlicht werden, wie sie auf Ihrer Dokumentationsseite erscheinen. Dieser Modus ist ideal, wenn Sie in Echtzeit sehen möchten, wie Ihre Änderungen aussehen.

Drücken Sie „/“, um das Komponentenmenü zu öffnen und formatierten Inhalt, Hinweisfelder, Code-Snippets oder andere Komponenten hinzuzufügen.

Markdown-Modus

Der Markdown-Modus bietet direkten Zugriff auf den zugrunde liegenden MDX-Code Ihrer Dokumentation. Dieser Modus ist ideal, wenn Sie die Eigenschaften von Komponenten präzise steuern möchten oder lieber in Markdown-Syntax schreiben.

Nächste Schritte

• Lerne die grundlegenden Git-Konzepte kennen.
• Erfahre Best Practices für die Zusammenarbeit mit Branches.
• Erkunde das Content-Management mit dem Web-Editor.
• Verstehe die Veröffentlichungsoptionen für verschiedene Szenarien.