Features of the IntelliJ AsciiDoc plugin

This document details the features available in the plugin to users of the plugin. Use it as a reference guide to find out what the plugin can do today. The plugin should work “like any other IntelliJ plugin” when it comes to shortcuts and configurations. If not, please describe the expected behaviour in a GitHub issue.

Please consider contributing to this document: open a bug when something is unclear, missing or wrong. You can even create a pull request for this document!

Benefits of this plugin

The IntelliJ AsciiDoc Plugin adds to your IDE:

  • A context-sensitive editor with syntax highlighting, auto-completion and in-line validation messages.

  • A configurable preview to proof-read and navigate the content.

  • Integrations to a Markdown-to-AsciiDoc converter, in-line diagrams like PlantUML, Antora, a static site generator, and Spring REST docs.

Context-sensitive editor

  • Recognizes the AsciiDoc file extension (.adoc, .asciidoc, .ad)

  • Toolbar and context menu for basic formatting and to create tables.

Learn more about it in section Features of the Editor.

Configurable preview

  • Provides a two-pane AsciiDoc preview editor based on AsciidoctorJ with live preview.

    Per default it has a vertical split and the preview is on the right. Use the settings to flip editor and preview and change to a horizontal split.

Learn more about it in section Features of the preview.

Integrations to the AsciiDoc ecosystem

  • Refactor Markdown to AsciiDoc: Right click on a file, or use the Refactor menu, and the Markdown document will be replaced by the AsciiDoc equivalent.

    This supports Undo when you’re not happy with the result.