Um vscode optimal für das Schreiben in Asciidoc vorzubereiten, lohnt es sich, als erstes die entsprechende Erweiterung AsciiDoc zu installieren. Diese Erweiterung liefert die Basis, um direkt in den Dateien zu schreiben und in Fast-Echtzeit das Ergebnis in eine Vorschau (Preview) im Editor geliefert zu bekommen.
Optional, aber empfohlen sind auch die Erweiterungen für git ( sofern man git nicht eh auf der Kommandozeile nutzt): GitLens und GitHub Pull Requests and Issues
Daneben gibt es natürlich noch viele weitere kleine Helfer, die einem das Leben erleichtern können. Erwähnt sind daher nur die beiden wichtigsten für den Einstieg.
Um alle Vorteile zu nutzen, gibt es ein paar Basiseinstellungen für einen bequemen Start.
Der folgende Auszug ist aus den Einstellungen, wie sie in der Datei settings.json zu sehen sind:
{
"asciidoc.preview.style": "checkmk.css",
"asciidoc.preview.useEditorStyle": false,
"asciidoc.previewFrontMatter": "show",
"asciidoc.preview.attributes": {
"global": "../attributes/global_attr.adoc",
},
}
Mit der direkt angegebenen Einstellung zur Datei global_attr.adoc können die globalen, vom Projekt selbst definierten Attribute bequem genutzt werden.