Dokument erstellen
In docStatic schreiben Sie Ihre Inhalte als Markdown in Dateien namens „Topics“. In der Regel erstellen Sie jedes Thema selbst, obwohl bestimmte Arten von Dokumenten automatisch generierte Themen haben können.
Hinweis
GraphQL- und OpenAPI-Dokumente werden automatisch von einem Server oder Schema generiert.
So erstellen Sie ein Thema:
- Klicken Sie in der Sammlung Themen auf Datei hinzufügen.
- Geben Sie dem Thema einen Titel.
- (Optional) Wenn Sie das Thema in der kontextsensitiven Hilfe verwenden möchten, geben Sie ihm einen Slug. Dies ist ein fester Pfad von
/docs/. - Geben Sie dem Thema eine Beschreibung. Diese wird in der Dokumentenkartenliste angezeigt.
- (Optional) Fügen Sie alle erforderlichen Taxonomie Tags hinzu.
- (Optional) Legen Sie alle Bedingungen fest.
- Stellen Sie sicher, dass der Workflow-Status auf Entwurf gesetzt ist.
- Geben Sie Ihren Inhalt ein.
- Klicken Sie auf Speichern.
Doc-Vorspann
Am Anfang jedes Themas befindet sich ein Abschnitt in YAML, der zwischen zwei Sätzen von drei Bindestrichen (---) steht. docStatic verwendet dies für folgende Zwecke:
- Bedingter Text
- Taxonomien (Dokument-Tags)
- Workflows
Weitere Informationen finden Sie unter Dokument erstellen in der Docusaurus-Dokumentation.