Recommended settings

Take a minute for the essential configuration settings of the plugin.

Configuring editor

  1. An AsciiDoc recommended practice is to have one sentence per line. This can lead to lines larger than the editor’s width.

    Using soft wraps will make the content readable in the editor, as each line wraps at the width of the editor.

    Go to File  Settings…​  Editor  General  Soft Wraps and enable soft wrap for the file extension you use for AsciiDoc files (usually *.adoc)

    Editor settings showing soft wrap

Configuring preview

  1. To get the best preview experience, switch the preview browser to JavaFX WebView or JCEF Browser. See below how to enable JavaFX or JCEF for Android studio.

    Go to menu File  Settings…​  Languages & Frameworks  AsciiDoc to review or change this setting. If neither JavaFX of JCEF preview is not available, refer to Installation Prerequisites.

    AsciiDoc settings

If your preview is blurry, follow these instructions to remedy this.

Enable JavaFX or JCEF for Android Studio

To use a rich preview for Android Studio, you’ll need to download additional components. For Android Studio 4.0+, enable JavaFX preview by upgrading the bundled JDK. For Android Studio 4.2+, enable JCEF preview by upgrading the bundled JDK.