Get help

If you run into a problem you cannot solve, open an issue on the issue tracker.

Before opening an issue, search the existing issues — your problem may already have been reported and solved.

When you open an issue, include the following information:

  1. A description of the issue.

  2. Your VS Code version, OS (Help → About), and extension version.

  3. Steps to reproduce the issue.

    We cannot solve the issue if you do not explain how you encountered it.

  4. If the problem occurs only with a specific file, attach it, along with any screenshot that helps illustrate the issue.

  5. The extension logs, which often point straight at the cause (see Logs).

If a problem appeared right after an update, you can roll back to a previous version. See Update.

Logs

The extension writes its logs to a dedicated Asciidoctor output channel, so you can read them without opening the developer tools.

To view the logs:

  1. Open the Output panel with View → Output (or Output: Focus on Output View from the Command Palette).

  2. Select Asciidoctor in the channel dropdown on the right.

By default, only informational messages, warnings, and errors are shown. To capture more detail when reproducing a problem, raise the verbosity:

  1. Run Developer: Set Log Level…​ from the Command Palette.

  2. Choose Asciidoctor (to change only this extension), then pick Trace to capture everything.

When you open an issue, reproduce the problem with the log level set to Trace, then copy the relevant lines from the Asciidoctor output channel into the issue.