# asciidoctor-intellij-plugin

**Repository Path**: mirrors_krasa/asciidoctor-intellij-plugin

## Basic Information

- **Project Name**: asciidoctor-intellij-plugin
- **Description**: AsciiDoc plugin for products on the IntelliJ platform (IDEA, RubyMine, etc)
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2025-12-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= IntelliJ AsciiDoc Plugin
Erik Pragt
:experimental:

A plugin for the IntelliJ platform (IntelliJ IDEA, RubyMine, etc) that provides support for the http://www.asciidoc.org[AsciiDoc] markup language. You can install the plugin (named "AsciiDoc") from the plugins section inside your Jetbrains IDE or download it from the https://plugins.jetbrains.com/plugin/7391[Jetbrains Plugin Repository]. 

== Current version: 0.7 SNAPSHOT

=== 0.6

Convert Markdown to AsciiDoc. Also accessible by using the `Refactor -> Convert to AsciiDoc menu`.

image::https://cloud.githubusercontent.com/assets/46468/5423595/8411b45a-82c5-11e4-9310-ed3d872381ac.gif[]

=== 0.4

link:https://cloud.githubusercontent.com/assets/46468/5202715/c2bfdcec-7580-11e4-91f6-82f9be257b5d.gif[Screencast]

Usable in the following JetBrains products:

- IntelliJ IDEA
- WebStorm and PhpStorm
- PyCharm
- RubyMine

== Features

* Since 0.7: Right click on a document to apply basic formatting or create tables.
* Since 0.6: 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!
* Since 0.4: recognizes the AsciiDoc file extension (.adoc, .asciidoc, .ad)
* Since 0.4: provides a two-pane AsciiDoc preview editor based on https://github.com/asciidoctor/asciidoctorj[AsciidoctorJ] with Live preview.

If you are missing features, please don't hesitate to let me know on Twitter: http://www.twitter.com/epragt[@epragt] or make an issue in the issue tracker!

== Dependencies

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 https://github.com/bodiam/markdown-to-asciidoc[Markdown to AsciiDoc] converter.

== Build

To build this plugin, you need to:

. download the IntelliJ IDEA Community Edition (at a minimum)
. open the project
. set the project SDK to be the IDEA Plugin SDK (and make sure this points to a valid Java SDK)
. build the project by selecting menu:Build[Prepare Plugin Module {apos}AsciiDoc Plugin{apos} for Deployment]

You can then install the plugin from the generated zip file in any IntelliJ platform product.

== Copyright and Licensing

Copyright (C) 2013-2014 Julien Viet and Erik Pragt.
Released under the Apache License, Version 2.0 (see link:LICENSE[LICENSE]).

== Credits

This plugin is based on the https://github.com/nicoulaj/idea-markdown[Intellij Markdown plugin by Julien Nicoulaud].

Also, great help was received from Harro Lissenberg, Alexander Schwartz and Dan Allen. Thank you all for your support!