dev.adoc

How to setup your development environment

Writing with Visual Studio Code (vscode)

Basic setup

To prepare vscode optimally for writing in Asciidoc, it is useful to first install the corresponding AsciiDoc extension. This extension provides the basis to write directly in the files and to get in near-real time the result delivered in a preview in the editor.

Optional, but recommended are also the extensions for git (if you don’t use git on the command line anyway): GitLens and GitHub Pull Requests and Issues

In addition, there are of course many other little helpers that can make your life easier. Mentioned therefore only the two most important for the start.

Recommended settings for the AsciiDoc extension

In order to take full advantage, there are a few basic settings for a comfortable start. The following excerpt is from the settings as seen in the settings.json file:

{
    "asciidoc.preview.style": "checkmk.css",
    "asciidoc.preview.useEditorStyle": false,
    "asciidoc.previewFrontMatter": "show",
    "asciidoc.preview.attributes": {
        "global": "../attributes/global_attr.adoc",
    },
}

With the directly specified setting to the global_attr.adoc file, the global attributes defined by the project itself can be conveniently used.