Since AsciiDoc syntax is just plain text, you can write an AsciiDoc document using any text editor. You don’t need complex word processing programs like Microsoft Word or Google Docs. In fact, you shouldn’t use these programs because they add cruft to your document that you can’t see that makes conversion tedious.
Here’s an overview of the different ways to preview and edit your AsciiDoc documents.
The following IDEs and text editors support the AsciiDoc syntax and provide document preview rendering with Asciidoctor.
Install Atom. Then from the Atom editor menus, navigate to . From there, open the Packages tab and install:
- AsciiDoc Preview
enables live preview
- AsciiDoc Language
enables syntax highlighting (AsciiDoc language support)
- AsciiDoc Image Helper
provides the ability to paste images from the clipboard
- AsciiDoc Autocomplete
automatically completes AsciiDoc language items
- AsciiDoc Assistant
Installs useful components to Atom for editing AsciiDoc files (including the above packages)
Then from the Brackets file menu, open the extension manager.
Browse available extensions and install
The community AsciiDoc plugin adds support to edit AsciiDoc files in the IDE with syntax highlighting, auto-completion and a live preview. It includes support for Antora and Spring REST Docs and creates PDFs using Asciidoctor PDF.
It works with the free community editions as well as with the paid editions of IntelliJ IDEA, CLion, PhpStorm, RubyMine, Android Studio etc.
Visual Studio Code provides rich language support for AsciiDoc and a live preview as you type.
Install Visual Studio Code.
Launch Visual Studio Code and open the Quick Open dialog by pressing Ctrl+P.
Type the following command to locate and install the AsciiDoc extension (by João Pinto):
ext install asciidoctor.asciidoctor-vscode