Codeblöcke und Codeausschnitte

docStatic bietet zwei Möglichkeiten, Code in Ihre Dokumentation einzufügen. Beide unterstützen die Syntaxhervorhebung.

Codeblöcke

1. Klicken Sie im Rich-Text-Editor auf das Symbol Codeblock.
2. Klicken Sie auf die Sprachenliste und wählen Sie eine Sprache aus oder suchen Sie danach.
3. Geben Sie Ihren Code in das Feld ein.

Beispiel:

This is some plain text.

Code-Schnipsel

1. Wählen Sie Code-Schnipsel aus der Liste Einbetten aus.
2. Geben Sie einen Titel ein.
3. Wählen Sie eine Sprache aus.
4. Wählen Sie eine Datei aus der Liste aus. Die Liste wird jedes Mal, wenn Sie den Entwicklungsserver starten oder einen Build durchführen, mit allen Dateien aus dem Ordner reuse/code/ gefüllt.

Beispiel:

Example Title

<div>
  <p>Example</p>
</div>

Der Vorteil der Verwendung von Code-Schnipseln besteht darin, dass es eine physische Datei gibt, die einer Unit-Test unterzogen werden kann.