https://github.com/de-jcup/eclipse-asciidoctor-editor

An eclipse editor for asciidoctor files
https://github.com/de-jcup/eclipse-asciidoctor-editor

asciidoc asciidoctor eclipse editor wysiwyg

Last synced: 6 months ago
JSON representation

An eclipse editor for asciidoctor files

• Host: GitHub
• URL: https://github.com/de-jcup/eclipse-asciidoctor-editor
• Owner: de-jcup
• License: other
• Created: 2018-03-15T08:06:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-13T23:13:22.000Z (9 months ago)
• Last Synced: 2025-03-31T12:08:02.421Z (6 months ago)
• Topics: asciidoc, asciidoctor, eclipse, editor, wysiwyg
• Language: Java
• Homepage: https://marketplace.eclipse.org/content/asciidoctor-editor
• Size: 88.8 MB
• Stars: 60
• Watchers: 8
• Forks: 17
• Open Issues: 76
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Asciidoctor Editor Logo](https://github.com/de-jcup/eclipse-asciidoctor-editor/blob/master/asciidoctor-editor-other/images/asciidoctor-editor-logo.png)

[![Java CI with Gradle](https://github.com/de-jcup/eclipse-asciidoctor-editor/actions/workflows/gradle.yml/badge.svg)](https://github.com/de-jcup/eclipse-asciidoctor-editor/actions/workflows/gradle.yml)

[![Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client](https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png)](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3976500 "Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client")

# In a nutshell

This an Eclipse plugin for editing [AsciiDoc](https://asciidoctor.org) files (`.adoc`, `.asciidoc`).  

In addition it adds editors [PlantUML](http://plantuml.com/) (`.plantuml`,`.pu`,`.puml`,`.iuml`) 

and [DITAA](http://ditaa.sourceforge.net/) (`.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 

- about the plugin take a look at https://github.com/de-jcup/eclipse-asciidoctor-editor/wiki

- about asciidoctor please  look at https://asciidoctor.org/docs/asciidoc-syntax-quick-reference

# 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)