A plugin for the IntelliJ platform (IntelliJ IDEA, RubyMine, etc.) that provides support for the AsciiDoc markup language. It also supports Antora, the documentation CMS build with AsciiDoc.
To contribute as a developer, some issues are labeled with “good first issue”. Maintainers are willing to help.
For more advanced topics, see tickets marked as “help wanted”. Feel free to choose these or any other ticket to participate, or create pull requests without a prior ticket.
You can install the plugin (named “AsciiDoc”) from the plugins section inside your JetBrains IDE or download it from the JetBrains Plugin Repository.
The most advanced and recommended preview modes (and default for new installations) are JavaFX and JCEF.
Refer to the installation for a detailed overview of the features.
-
Recognizes the AsciiDoc file extension (.adoc, .asciidoc, .ad)
-
Provides a two-pane AsciiDoc preview editor based on Asciidoctor with a live preview.
-
Toolbar and context menu for basic formatting and to create tables.
-
Convert AsciiDoc to Microsoft Word (DOCX) by using pandoc.
-
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. Also, supports undo if the user is not happy with the result!
Refer to the Features list for a detailed overview of the features.
If you are missing features, please don’t hesitate to let me know on Twitter: @ahus1de or create an issue in the GitHub issue tracker!
Refer to the CHANGELOG for a list of changes in previous releases.
This project uses AsciidoctorJ and JRuby for the rendering of the AsciiDoc content.
For the conversion of Markdown to AsciiDoc, we use Pegdown and the Markdown to AsciiDoc converter.
Issues that can give you a good start are have the label “good first issue” and maintainers are willing to help. Feel free to choose these or any other ticket to contribute, or even create pull requests without a prior ticket.
Please have a look at the “Contributor Guide”. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Asciidoctor Community Code of Conduct.
Copyright © 2013-2020 Julien Viet, Erik Pragt, Alexander Schwartz and the individual contributors. Released under the Apache License, Version 2.0 (see LICENSE).
An early version of the plugin is based on the Intellij Markdown plugin by Julien Nicoulaud. Later versions took inspiration from the JetBrains Markdown plugin.
Also, great help was received from Erik Pragt, Harro Lissenberg, Alexander Schwartz and Dan Allen. Thank you all for your support!