Skip to main content
  • Create account
  • Log in
Eclipse Plugins, Bundles and Products - Eclipse Marketplace
  • My Marketplace
  • Add Content
  • More
      • Community

      • Marketplace
      • Events
      • Planet Eclipse
      • Newsletter
      • Videos
      • Blogs
      • Participate

      • Report a Bug
      • Forums
      • Mailing Lists
      • Wiki
      • IRC
      • Research
      • Eclipse IDE

      • Download
      • Learn More
      • Documentation
      • Getting Started / Support
      • How to Contribute
      • IDE and Tools
      • Newcomer Forum
  1. Home
  2. Marketplace
  3. Tools (1287)
  4. Asciidoctor Editor

Asciidoctor Editor

Asciidoctor Editor
104
10
Install

Drag to Install!

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

Add this URL to your Eclipse Installation to reach this solution's update site.

2020-09 (4.17)
2020-06 (4.16)
2020-03 (4.15)
2019-12 (4.14)
2019-09 (4.13)
2019-06 (4.12)
2019-03 (4.11)
2018-12 (4.10)

https://dl.bintray.com/de-jcup/asciidoctoreditor

Learn more...

Details Group Tabs

Details

Asciidoctor Editor

This eclipse plugin is a text editor for asciidoc files.

Features

  • Fast html preview
  • Uses ASP for out-of-the-box usage (no installation of asciidoctor required) or can use installed asciidoctor with customizable CLI arguments
  • Can export to PDF
  • Code completion for pathes used in includes, images, diagrams etc.
  • Supports text based diagram generation
    ( ditaa, plantuml and graphviz )
  • 3 different preview modes:
    • Inline preview with editor
      • Vertical splitted
      • Horizontal splitted
      • Both variantes are immediately updated on text save
      • When cursor comes in line of anchor or headline it automatically scrolls internal preview to location - also opposite way, when selecting a headline in preview the editor part will be selected and shown (if not an included part...)
    • External preview
      • Using external Browser
      • Update per autorefresh in browser
        • time configurable
        • can be turned off also
      • Interesting when having multiple monitors and wanting to have full sized text document and preview
  • Outline and Quickoutline
    • Headlines
    • Includes (double click opens file)
  • Syntax highlighting in Text Editor
    • Colors can be customized.
    • Dark theme automatic color support.
  • Templates + Simple code completion for existing words
  • Tooltips
  • Hyperlinking of include parts (CTRL+Mouse)
  • Can search for references of asciidoc files in workspace
  • Convenient toolbar actions
    • Table wizard
    • Code block templates
    • Possibility to toggle TOC on/off in output view
    • Switch preview layout variant
    • Jump to top of preview (internal preview panel only)
  • Additional editors included for
    • .ditaa files
    • .plantuml files
  • Can convert one file or multiple files in selected folder
    • Formats supported:
      • markdown (*.md)

Links related to the plugin

  • Issue Tracker
  • Release history
  • Wiki
  • YouTube Video playlist

Additional links

  • Asciidoctor Quickreference for details about syntax
  • ditaaon github
  • plantuml
  • graphviz

Technical details

  • It uses internally ASP server or installed asciidoctor to provide a WYSWYG integration.
  • When using plantuml (or graphviz itself) you must ensure you have installed graphviz on your machine
Categories:
  • Documentation,
  • Editor,
  • Tools
Tags:
  • asciidoc,
  • asciidoctor,
  • fileExtension_adoc,
  • wysiwyg,
  • ditaa,
  • plantuml,
  • graphviz,
  • documentation,
  • doc,
  • agile documentation,
  • text,
  • editor,
  • adoc,
  • fileExtension_ditaa,
  • fileExtension_plantuml,
  • fileExtension_puml,
  • fileExtension_iuml,
  • fileExtension_pu,
  • filextension_asciidoc
Additional Details
Eclipse Versions: 
2020-09 (4.17), 2020-06 (4.16), 2020-03 (4.15), 2019-12 (4.14), 2019-09 (4.13), 2019-06 (4.12), 2019-03 (4.11), 2018-12 (4.10)
Platform Support: 
Windows, Mac, Linux/GTK
Organization Name: 
Albert Tregnaghi
Date Created: 
Thu, 2018-03-15 15:51
Development Status: 
Production/Stable
License: 
Apache 2.0
Date Updated: 
Sat, 2020-10-03 11:23
Submitted by: 
Albert Tregnaghi
Screenshots
Metrics
DateRankingInstallsClickthroughs
January 2021137/890297 (0.11%)24
December 2020155/919370 (0.09%)34
November 2020136/925497 (0.11%)39
October 2020139/927513 (0.11%)55
September 2020137/894423 (0.09%)42
August 2020153/867284 (0.08%)26
July 2020139/870399 (0.1%)28
June 2020133/867448 (0.1%)30
May 2020127/876550 (0.11%)29
April 2020142/891508 (0.1%)27
March 2020138/892592 (0.11%)34
February 2020136/885530 (0.11%)33
View Data for all Listings
Errors

Unsuccessful Installs in the last 7 Days: 2

CountError Message
2Cannot continue the operation. There is another install operation in progress.
Download last 500 errors (CSV)
External Install Button

Marketplace Drag to Install button

By adding the following code below to your website you will be able to add an install button for Asciidoctor Editor.

HTML Code:


Markdown Syntax:



Output: Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client
Tuesday, January 19, 2021 - 12:21

Reviews Sign in to post reviews

mmoseri5v's picture

puml functionality not working

Submitted by Michael Moser on Sun, 2020-11-01 15:23

Freshly installed the plugin into my Eclispe 2020-09.
When I try to render a .puml file all I get is:

dot executable: null
NO dot executable found
Cannot find Graphviz. You should try

@startuml
testdot
@enduml

or java -jar plantuml.jar -testdot

Any hint or guess what's not working?

Eclipse Version: 2020-09 (4.17.0) / Build id: 20200910-1200

AsciiEditor: 2.2.0

Later edit: providing a test-file as suggested by the error message yields another error stating:

PlantUML version 1.2019.12 (Sun Nov 03 11:24:54 CET 2019)
The environment variable GRAPHVIZ_DOT has not been set
Dot executable is null
Error: Not dot executable found
Error: Only sequence diagrams will be generated.

That's at least telling a bit more. But what should I set this environment variable to? Some hints or instructions what one needs to (install and) configure before being able to use this plugin would have been helpful! Because I would have expected that this would run as-is after installing the plugin...

 

aaiezza's picture

Re: puml functionality not working

Submitted by Alex Aiezza on Thu, 2020-12-03 10:17

I too, would benefit from a fix.
Thank you!

In the meantime, @Michael Moser, the PlantUML plugin seems to still work great!

mmoseri5v's picture

Re: puml functionality not working

Submitted by Michael Moser on Sun, 2020-11-01 15:37

Googling further brought me here: https://github.com/de-jcup/eclipse-asciidoctor-editor/issues/47 which - among other stuff - had a link to- the download page for the graphviz utility (which is obviously required to render these files): https://www.graphviz.org/download/

I downloaded and installed the "Development Windows install packages" (x64 version) and after that the .puml visualization now works!

You may want to provide these instructions here on the plugin download page somewhere.

mjanuf3y's picture

yml rendering configuration usage

Submitted by Mario Janu on Tue, 2020-09-29 10:42

hi, how am i able to let the ascii doctor editor use my custom yml file to render it in the eclipse editor?

it is used correctly when i render via mvn.

thanks & regards

atregnaghi's picture

Re: yml rendering configuration usage

Submitted by Albert Tregnaghi on Sat, 2020-10-03 11:10

Hello Mario,

I think you were talking about inlcuding  a yaml file example inside an asciidoc file.
I created Issue #96 at github to check for problems with yaml rendering.
Tried out embedded variant and also by including a file.

Both ways work out of the box, as shown in picture inside github issue.
If there are still questions/problems please add them to github issue.

Best wishes

Albert

jmenoyo's picture

Great Post

Submitted by Jorge Menoyo on Thu, 2019-07-11 08:08

Its a good post from reolve the problem.

I have a  [www.bilbolink.com/]

Tacnks!

atregnaghi's picture

Version 2.0.2 available - fixes Windows OS startup problem

Submitted by Albert Tregnaghi on Tue, 2019-07-09 19:09

Release 2.0.0 did not work with Windows OS - see https://github.com/de-jcup/eclipse-asciidoctor-editor/issues/248 for details.
Is fixed with 2.0.2

atregnaghi's picture

Version 1.4.2 now available, install problems fixed

Submitted by Albert Tregnaghi on Thu, 2019-04-11 18:31

There were some issues with 1.4.0, 1.4.1 and 1.4.2 installation. This is fixed now and 1.4.2 can be installed without problems.

Sorry about the inconvenience.

Best wishes
Albert

PS: Parts inside library plugin has been updated as well, so this update is bigger than usual (~37 MB)

ovikevry's picture

Handshake failure

Submitted by Ole Jonny Vikevry on Tue, 2018-12-18 03:40

When I try to install the plugin, the process fails with the log statement shown below. The same error occurs both via the Install link on this site, Eclipse marketplace and Update site:

Using Eclipse 2018-09 on Win10.

(I have padded urls with whitespace due to form validation)

An error occurred while collecting items to be installed session context was:(profile=epp.package.jee, phase=org.eclipse.equinox.internal.p2.engine.phases.Collect, operand=, action=). Unable to read repository at h t t p s : / / dl.bintray.com/de-jcup/asciidoctoreditor/plugins/de.jcup.asciidoctoreditor_1.2.0.jar. Received fatal alert: handshake_failure Unable to read repository at h t t p s : //dl.bintray.com/de-jcup/asciidoctoreditor/plugins/de.jcup.asciidoctoreditor.libs_1.2.0.jar. Received fatal alert: handshake_failure

Please advice

atregnaghi's picture

Re: Handshake failure

Submitted by Albert Tregnaghi on Tue, 2018-12-18 10:16

Reproducing problem

I tried following: I downloaded https://dl.bintray.com/de-jcup/asciidoctoreditor/plugins/de.jcup.asciido... directly inside my browser (e.g. chrome) and had no certificate problems - or just open https://dl.bintray.com/de-jcup/asciidoctoreditor/plugins/

I also got a fresh eclipse 2018-09 and installed Asciidoctor Editor by marketplace (from a german location) and had no problems. Installation was done.

So I was not able to reproduce your problem.

About the problem

This sound like a SSL problem. Maybe you got the same probleme as described at https://github.com/gnu-mcu-eclipse/eclipse-plugins/issues/171 (other plugin but same issue)

Possible next steps

Please try to download the jar file or view the folder with your browser as described above.

If you have also SSL problems with your browser you could have a either 

- proxy  problems
- bintray is rolloing out new certificates (in this case please try a little bit later asgain)
- a "man in the middle"...

If it works in your browser than you could have a problem with your java version running your eclipse.

To solve this you can do either:

- import bintray certificates in java store of your JVM used for eclipse
- update your JVM used for starting eclipse or
- start your eclipse with another - suitable - JVM instance

Hope this helps
Albert

Markets

  • Eclipse Project (5)
  • Tools (1287)
    • Application Development Frameworks (155)
    • Application Management (27)
    • Application Server (37)
    • BIRT (10)
    • Build and Deploy (102)
    • Business Intelligence, Reporting and Charting (14)
    • Code Management (115)
    • Collaboration (35)
    • Database (45)
    • Database Development (33)
    • Database Persistence (17)
    • Documentation (59)
    • Eclipse Kura (64)
    • Eclipse SmartHome (45)
    • EclipseRT Target Platform Components (8)
    • Editor (332)
    • Entertainment (14)
    • General Purpose Tools (120)
    • Graphics (32)
    • IDE (327)
    • Internet of Things (IoT) (33)
    • J2EE Development Platform (42)
    • J2ME (6)
    • Languages (149)
    • Linux Tools (18)
    • Logging (22)
    • Mobile and Device Development (49)
    • Modeling (89)
    • Modeling Tools (141)
    • Mylyn Connectors (18)
    • Network (13)
    • Other (71)
    • Process (19)
    • Profiling (22)
    • Programming Languages (98)
    • Reporting (33)
    • Rich Client Applications (38)
    • Science (5)
    • SCM (17)
    • Search (40)
    • SOA Development (15)
    • Source Code Analyzer (96)
    • Systems Development (53)
    • Team Development (55)
    • Testing (86)
    • Tools (550)
    • UI (90)
    • UML (40)
    • Web (89)
    • Web Services (31)
    • Web, XML, Java EE and OSGi Enterprise Development (35)
    • XML (30)
  • IoT (113)
    • Eclipse Kura (64)
    • Eclipse SmartHome (45)
  • RCP Applications (78)
  • Training & Consulting (52)
  • Long Term Support (11)

Search

Advanced Search

More like this

  • ASCII UML (asciidoc editor + plantuml plugin)
  • Mylyn WikiText
  • LiClipseText
  • LiClipse
  • FluentMark

Favorited by

Eclipse Foundation

  • About Us
  • Contact Us
  • Donate
  • Members
  • Governance
  • Code of Conduct
  • Logo and Artwork
  • Board of Directors

Legal

  • Publishing Guidelines
  • Privacy Policy
  • Terms of Use
  • Copyright Agent
  • Eclipse Public License
  • Legal Resources

Useful Links

  • Welcome to Marketplace
  • Report a Bug
  • Documentation
  • How to Contribute
  • Mailing Lists
  • Forums
  • Marketplace

Other

  • IDE and Tools
  • Projects
  • Working Groups
  • Research@Eclipse
  • Report a Vulnerability
  • Service Status

Copyright © Eclipse Foundation. All Rights Reserved.

Back to the top