Markdown-Funktionen
docStatic nutzt Markdown als Hauptformat für die Erstellung von Inhalten. Sie können es in zehn Minuten erlernen. Das ist jedoch nicht unbedingt erforderlich, da das CMS eine umfassende Rich-Text-Bearbeitungsumgebung für Metadaten, Markdown und React-Komponenten bereitstellt.
Einfaches, strukturiertes Erstellen von Inhalten
Themen in docStatic bestehen aus drei Teilen:
- Metadaten (im YAML-Format)
- Inhalt (in Markdown)
- Vordefinierte React-Komponenten.
Das CMS stellt sicher, dass Metadaten und Markdown konsistent verwendet werden, während die React-Komponenten einen einheitlichen Stil gewährleisten und Funktionen zur Wiederverwendung von Inhalten unterstützen. Sie müssen selbst keinen JSX-Code hinzufügen, da die Komponenten bereits global verfügbar sind.
Standardfunktionen
Zu den Markdown-Funktionen gehören:
- Zeichenformate wie Fettdruck, Code, Kursivschrift und Durchstreichen.
- Aufzählungs- und Nummerierungslisten.
- Codeblöcke.
- Überschriftenebenen (1 bis 6).
- Horizontale Linien.
- Bilder.
- Links.
- Zitate.
- Einfache Tabellen.
All diese Funktionen können direkt über die Rich-Text-Symbolleiste im CMS ausgewählt werden.
Dazu fügt Docusaurus Folgendes hinzu:
- Hinweise
- Details (erweiterbare Inhalte)
- Doc-Karten-Listen
- Registerkarten
docStatic erweitert dies zusätzlich um:
- Code-Schnipsel (aus Dateien)
- Kommentare
- Bedingter Text
- Kontext-Hilfe-Links
- Diagramme
- Abbildungen
- Fußnoten
- Glossarbegriffe
- Mathematische Gleichungen
- Verwandte Themen (automatisch generiert)
- Snippets
- Variablen
Front Matter
Front Matter dient dazu, Ihrer Markdown-Datei Metadaten hinzuzufügen. Sie wird ganz am Anfang der Datei angegeben und durch drei Bindestriche --- eingerahmt. Inhalts-Plugins können über ein eigenes Front-Matter-Schema verfügen. docStatic verwendet die Front Matter für:
- Bedingungen (für bedingten Text)
- Beschreibungen
- Slugs (feste Pfade)
- Taxonomie-Tags
- Titel
- Workflow-Status
Details
- Wählen Sie Details aus der Liste Einbetten aus.
- Bearbeiten Sie die Komponente.
- Geben Sie eine Zusammenfassung ein.
- Geben Sie die Details ein.
Beispiel:
Anzeigen/Ausblenden.
Dies ist der detaillierte Inhalt.
Sie können hier Markdown verwenden, einschließlich fett und kursiv formatiertem Text sowie eingebetteten Links.
Doc-Kartenlisten
Doc-Kartenlisten werden automatisch für Kategorien im Inhaltsverzeichnis generiert. Sie können sie jedoch auch manuell zu einem Thema hinzufügen.
- Wählen Sie Doc-Kartenliste aus der Liste Einbetten aus.
- Geben Sie ihr einen Titel.
Weitere Informationen finden Sie unter Markdown-Funktionen in der Docusaurus-Dokumentation.
Beispiel:
Admonitions
Mit der Komponente Hinweise können Sie formatierte Hinweise einfügen.
Assets
Manchmal möchten Sie direkt aus Themen heraus auf Assets (z. B. DOCX-Dateien, Bilder usw.) verlinken. docStatic verwaltet dies über den Ordner „static/“.
CALS Tables
Using CALS tables in docStatic, including merged cells, column widths and border control.
Citations
1 Eintrag
Code blocks and snippets
docStatic bietet zwei Möglichkeiten, Code in Ihre Dokumentation einzufügen. Beide unterstützen die Syntaxhervorhebung.
Comments
Mit der Komponente Kommentar können Sie Kommentare hinzufügen, die im CMS sichtbar sind, jedoch nicht auf der gerenderten Seite – auch nicht im Quellcode.
Conditional text
Mit der Komponente Bedingter Text können Sie Inhalte in eine Reihe von Bedingungen einbinden, die festlegen, wann diese angezeigt werden sollen:
Context-sensitive help
„Kontextsensitive Hilfe ist eine Art von
Diagramme
Diagramme mit Mermaid erstellen.
Abbildungen
Bilder mit Bildunterschriften und Lightbox-Zoom.
Fußnoten
Automatisch nummerierte Fußnoten mit Rücksprung.
Glossary terms
Mit der Komponente Glossarbegriff können Sie einen Schlüssel eingeben, der einem lokalisierten Begriff und einer Beschreibung zugeordnet ist. Der Begriff wird unterstrichen angezeigt. Wenn Sie den Mauszeiger über den Begriff bewegen, wird der Hilfecursor angezeigt, und beim Verweilen über dem Begriff erscheint die Beschreibung als Tooltip. Auf Touchscreen-Geräten wird durch Antippen des Begriffs eine Popup-Definition angezeigt.
Head metadata
docStatic fügt automatisch nützliche Seiten-Metadaten in `, und ` für Sie ein.
Headings and table of contents
Im CMS können Sie die Ebene Absatz oder Überschrift (von 1 bis 6) auswählen.
Markdown links
Es gibt zwei Möglichkeiten, einen Link zu einer anderen Seite hinzuzufügen: über einen URL-Pfad oder einen Dateipfad.
Math equations
Mathematische Gleichungen können mit dargestellt werden.
MDX and React
docStatic bietet integrierte Unterstützung für MDX, wodurch Sie JSX in Ihren Markdown-Dateien schreiben und als React-Komponenten rendern können. Wenn Sie JSX jedoch direkt in Ihre Themen einfügen, kann das CMS diese nicht im Rich-Text-Editor anzeigen.
MDX plugins
MDX verfügt über ein integriertes Plugin-System, mit dem Sie die Art und Weise anpassen können, wie Markdown-Dateien geparst und in JSX umgewandelt werden. Wenn Sie jedoch das Verhalten von Markdown ändern, müssen Sie diese Änderungen auch im CMS berücksichtigen.
Related Topics
Die Komponente Verwandte Themen schlägt automatisch verwandte Inhalte basierend auf gemeinsamen Taxonomie-Tags vor. Sie analysiert die Tags der aktuellen Seite und findet andere Dokumente mit ähnlichen Tags, die dann als kuratierte Empfehlungsliste angezeigt werden.
Snippets
Mit der Snippet-Komponente können Sie Inhalte in Ihrer gesamten Dokumentation wiederverwenden. Ein Snippet ist ein Inhaltsabschnitt, der in ein oder mehrere Themen eingefügt werden kann. Wenn Sie Änderungen am Snippet vornehmen, werden diese überall dort übernommen, wo das Snippet verwendet wird. Dies kann insbesondere bei Standardtexten nützlich sein. Snippets verfügen im CMS über eine eigene Sammlung und sind in einem separaten Bereich des Repositorys gespeichert.
Tabs
Mit der Komponente Registerkarten können Sie Ihrem Thema Inhalte mit Registerkarten hinzufügen.
Variable sets
Mit der Komponente „Variable“ können Sie eine lokalisierte Variable in Ihren Text einfügen.