A plugin for the IntelliJ platform (IntelliJ IDEA, RubyMine, etc) that provides support for the AsciiDoc markup language. To support the authors of Asciidoctor, please consider supporting us via OpenCollective.
This plugin joined Hacktoberfest! Issues that can give you a good start are have the label "Hacktoberfest" and maintainers are willing to help. Feel free to choose these or any other ticket to participate, or even create pull requests without a prior ticket).
You can meet the maintainers in person: Please ping them via eMail or chat before or during the event!
-
Alex at JavaLand (Brühl, DE), 2020-03-16..18
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 mode (and default for new installations) is JavaFX.
To use the JavaFX preview instead of the Swing preview, you’ll need to run IntelliJ with 64bit Java and JavaFX installed. Oracle JDK installations include JavaFX, but can make the IDE unstable and crash. Pre-bundled OpenJDK installations usually don’t include JavaFX. Therefore, JetBrains OpenJDK pre-bundled with your IDE is recommended.
From 2017.1 onwards a JetBrains OpenJDK 64bit is included even in the Windows versions. Please only use the JDK provided by JetBrains, as the JavaFX rendering seems to be most stable in the JetBrains JDK. See Selecting the JDK version the IDE will run under for more details.
-
Recognizes the AsciiDoc file extension (.adoc, .asciidoc, .ad)
-
Provides a two-pane AsciiDoc preview editor based on AsciidoctorJ with live preview.
-
Toolbar and context menu for basic formatting and to create tables.
-
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, in case you’re 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 complete list of changes in older 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.
Please have a look at the "How to Build and Contribute" documentation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Copyright © 2013-2019 Julien Viet, Erik Pragt and Alexander Schwartz. Released under the Apache License, Version 2.0 (see LICENSE).
This plugin is based on the Intellij Markdown plugin by Julien Nicoulaud.
Also, great help was received from Erik Pragt, Harro Lissenberg, Alexander Schwartz and Dan Allen. Thank you all for your support!