#RUBYMINE CODE WITH ME FULL#
These are: Enable automatic language injection in source blocksĮnabling this setting enables the full language functionality for any supported language or file format in your source code blocks. Under Settings | Languages & Frameworks | AsciiDoc, there are two key options that you may want to make use of. This functionality is configurable if you feel that it’s not what you want, or you need to change it a bit. Oh, did I mention that this functionality extends to diff and merge tools too?! So it’s exciting to know that all of IntelliJ’s native code intentions and inspections and syntax highlighting are available to you. However, editing the code directly in the AsciiDoc file sure can be convenient at times. Sure, by storing source code in external files, it can be linted as part of the build process, by git hooks, and manually by me, which will ensure that the code is bug-free. In the screenshot below, you can see that on line five, it’s found an undefined variable. Now, if you appreciate how much of a wonderful surprise that was, imagine my further surprise when, after setting the source code type, I saw IntelliJ start linting the source code block. So imagine my surprise as I was setting the source language type in a source code block recently, and witnessed beautiful syntax highlighting take hold. That’s actually a bit of what motivated me to start including source files, instead of embedding source code directly in AsciiDoc. I’m used to seeing syntax highlighted in Firefox, when using the Asciidoctor.js plugin, but not directly in VIM. What I didn’t expect, however, was that the syntax highlighting would extend to source code blocks. So I’m aware of the quality of the syntax highlighting. Sure, I’ve been using PhpStorm, one of the IntelliJ IDEs for some time as my primary PHP editor, and have used IntelliJIDEA for Java and Kotlin. I honestly didn’t expect the syntax highlighting to be as good as it is. Where the Plugin Shines Excellent Syntax Highlighting Support Hopefully, it’s infectious (in the good way). It takes a lot of effort to do what and team have done and I really appreciate their hard work and dedication. What’s more, here’s what AsciiDoc (and Antora) project lead, Dan Allen, says about it: However, when you consider that the functionality of the plugin is combined with all of the pre-existing functionality available in IntelliJ IDEs, and with the functionality of any additional you may add, I hope that you start to see just how powerful a technical writing setup it presents. Now, on their own, these are some pretty awesome features. A configurable AsciiDoc preview for proof-reading AsciiDoc content.
#RUBYMINE CODE WITH ME TRIAL#
So, after he kept suggesting it for over 6 weeks, I decided to trial it for 4 weeks, exclusively, as my AsciiDoc editor, and see why he was so enthusiastic. However, Dan is very enthusiastic, and often very convincing. To be honest, I’d wanted to improve my VIM configuration, not to start with another tool. He’s been strongly advocating for the AsciiDoc Plugin for IntelliJ. However, of all the suggestions which I’ve received, the one I’ve heard the most, and the one that’s been advocated for most strongly, is by AsciiDoc and Antora project lead, Dan Allen. In the search for solutions to these, often minor, shortcomings in VIM, I’ve been seeking answers and workarounds in the Antora users Gitter forum and the AsciiDoc sub-channel in the Write the Docs Slack channel. However, this isn’t a deal-breaker, as I’ve also been using (and advocating) the Asciidoctor.js Live Preview plugin for Firefox and Chrome.Īs you can see in the image below, I can write and preview, virtually, at the same time. What’s more, it has no native preview functionality. However, there are little things that it doesn’t do, or I’ve either not found a plugin, or coded up a plugin to do.įor example, have I attempted to include an image or file using an incorrect file path. I love how VIM is so lightweight, so configurable, so easy to use. I’ve used it when working with my technical documentation clients and for the books and courses which I’ve created. In this post, I share everything that I learned.įor the longest time, I’ve been using VIM to write and maintain AsciiDoc content. I’ve been reviewing the AsciiDoc plugin for IntelliJ over the last four weeks.