Quick Start

A minimal installation guide for those already familiar with their JetBrains IntelliJ based IDE. Change to the page Installing the plugin for a more detailed guide, or Setup for technical writing for a step-by-step-guide installing IntelliJ for technical writing.

Prerequisite

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

To install the plugin on IntelliJ MPS or Google Android Studio, please refer to the chapter Installing the plugin.

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: …​ 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 Installing the plugin.

Post installation

Now that the installation is complete, every AsciiDoc file opens in an editor with syntax highlighting and a preview. Continue to section Configuring the plugin to configure a user’s environment.