Quick Start

A minimal installation guide for those already familiar with their JetBrains IntelliJ based IDE. Continue to section Plugin installation for a more detailed guide.


  1. An installed JetBrains IDE like IntelliJ IDEA, GoLand, WebStorm or PyCharm.
    This plugin fully supports the free IntelliJ IDEA Community edition.

Please use the pre-bundled JetBrains OpenJDK Runtime 11 to run your IDE. This provides the best live preview based on JavaFX or JCEF. You can check this in the menu Help  About.

It should state:

Runtime version: 11.0…​
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o

Please refer to Installation Prerequisites if this is not the case.

Plugin installation

  1. Install the AsciiDoc plugin from the JetBrains marketplace.

    Install AsciiDoc plugin from marketplace
  2. Restart your IDE to activate the plugin.

For detailed installation instructions, please follow the instructions in section Plugin installation.

Post installation

Now that the installation is complete, every AsciiDoc file will open in an editor with syntax highlighting and a preview. Continue to section Recommended settings to configure your environment.