Skip to content

de-jcup/eclipse-asciidoctor-editor

Repository files navigation

Asciidoctor Editor Logo

Java CI with Gradle

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

In a nutshell

This an Eclipse plugin for editing AsciiDoc files (.adoc, .asciidoc).
In addition it adds editors PlantUML (.plantuml,.pu,.puml,.iuml) and DITAA (.ditaa) files as well.

Features:

  • Vertical or horizontal splitted Text and Preview on same Editor
  • Syntax highlighting in Text Editor (Colors can be customized, defaults for dark themes exists too)
  • Preview panel is same output as generated HTML by ascii doctor (so WYSIWYG)
  • Preview panel immediately updated on text save

For more information

Plugin developers

How to build this plugin ?

Setup

  • call git clone https://github.com/de-jcup/eclipse-asciidoctor-editor.git
  • open a shell and go into eclipse-asciidoctor-editor folder
  • call gradlew installLibraries - this will install current asp dependencies etc. (so its not inside git)
  • call gradlew eclipse
  • After this is done open your eclipse and import ALL existing eclipse projects from eclipse-asciidoctor-editor into your workspace

Build

  • Gradle parts are only used for automated testing
  • To build the editor plugin, please open "asciidoctor-editor-updatesite/site.xml" with eclipse site editor and build Editor feature by pressing "Build" button inside.

Execute (development phase)

  • Simply start as Eclipse Application by a new launch configuration in eclipse

License

Eclipse asciidoctor editor is licensed under Apache 2.0 (see http://www.apache.org/licenses/LICENSE-2.0)

with-Eclipse logo