Asciidoctor Editor

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

2023-03 (4.27), 2022-12 (4.26), 2022-09 (4.25), 2022-06 (4.24), 2022-03 (4.23), 2021-12 (4.22), 2021-09 (4.21), 2021-06 (4.20), 2021-03 (4.19), 2020-12 (4.18), 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), 2023-06 (4.28), 2023-09 (4.29), 2023-12 (4.30), 2024-03 (4.31)

https://de-jcup.github.io/update-site-eclipse-asciidoctor-editor/update-site/

Learn more...
Solution Description

Asciidoctor Editor

This eclipse plugin is a text editor for asciidoc files.

Features

  • Fast html preview
  • Easy to use, no special project setup necessary (YouTube video)
  • Can generate overview graph for bigger documents (YouTube video)
  • 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. (YouTube video)
  • Supports text based diagram generation
    ( ditaa, plantuml and graphviz) (YouTube video)
  • 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...) (YouTube video)
    • 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
  • Provides asciidocconfig.adoc files (YouTube video, Wiki)
  • 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 (CTRL+Mouse) and opening in IDE:
    • included asciidoc files
    • plantuml diagrams
    • ditaa diagrams
    • images
    • cross references (YouTube video)
    • external links
  • Can search for references of asciidoc files in workspace (YouTube video)
  • 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)
  • PlantUML editor (from Asciidoctor Editor) has many PlantUML examples (e.g. C4 diagram examples) which can be injected by toolbar action.
  • Can override attributes globally by preferences/from toolbar (YouTube video)

Links related to the plugin

Additional links

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

Additional Details

Eclipse Versions: 2023-03 (4.27), 2022-12 (4.26), 2022-09 (4.25), 2022-06 (4.24), 2022-03 (4.23), 2021-12 (4.22), 2021-09 (4.21), 2021-06 (4.20), 2021-03 (4.19), 2020-12 (4.18), 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), 2023-06 (4.28), 2023-09 (4.29), 2023-12 (4.30), 2024-03 (4.31)

Platform Support: Windows, Mac, Linux/GTK

Organization Name: Albert Tregnaghi

Development Status: Production/Stable

Date Created: Thursday, March 15, 2018 - 15:51

License: Apache 2.0

Date Updated: Friday, October 6, 2023 - 10:50

Submitted by: Albert Tregnaghi

Screenshot
Date Ranking Installs Clickthroughs
February 2024 125/687 245 13
January 2024 119/691 299 14
December 2023 136/671 242 18
November 2023 148/686 241 22
October 2023 132/673 295 28
September 2023 115/663 340 18
August 2023 133/673 264 18
July 2023 137/668 239 23
June 2023 123/669 330 21
May 2023 124/671 324 12
April 2023 131/667 297 20
March 2023 0/0 0 19
View Data for all Listings

Unsuccessful Installs

Unsuccessful Installs in the last 7 Days: 0

Download last 500 errors (CSV)

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

Reviews Add new review

This version has some breaking changes + some new features

New features

- Global asciidoc model
- Overview diagram about current document + all included and used files  
  with warnings, errors etc. inside diagram
- Zoom level setup inside plantuml diagram editor internal preview
- Using SVG external view supports now always zoom capability...
- Possibility to define global custom attributes via preferences 
- Render preferences like "attributes" and "environment" are now directly 
  accessible by user from toolbar (dedicated action)

Breaking changes

- Output images are now always SVG
- Feature of persisting output images into source folder has been removed
- It was necessary to change custom environment preference key, so those
  preferences must be edited again (sorry)

More

- For details look at 
  https://github.com/de-jcup/eclipse-asciidoctor-editor/milestone/37?closed=1

I have installed the asciidoctor plugin on a second machine. Before I did I installed the GraphViz stuff and tested it and its working (you see - I learned my lesson with this plugin).

But now I have another most annoying effect:

If I create a testfile containing just 

@startuml
testdot
@enduml

and save it then the plugin kicks in and a few seconds later I get an "image" that reads:

PlantUML verson 1.2021.2 (Sun Mar 07 12:10:27 CET 2021)
Dot version: dot - graphviz version 2.47.1 (20210417.1919)
Installation seems OK. File generation OK

So, the config seems to be working.
 

However, as soon as I save a file that contains more than just 2-3 components or classes then the image generation always hangs "forever" (i.e. a minute or so) and all I ever get is a message like:

Preview file generation timed out, so preview not available at: 
C:\Users\mmo\AppData\Local\Temp\asciidoctor-editor-temp\project_example_app-174616751\-1369575984_internal_mainclasses.html

My Laptop is pretty fast (i7 CPU (10th gen), 16GB RAM, 1TB SSD, etc.) so I doubt that a simple picture with maybe 10 rectangles can really be taking so long that the graph generation times out. 
Any idea what could cause this? 

This is on eclipse 2021-03.

In reply to by Hermann Kneissel

I just tested - and most plugins are no longer hosted at https://bintray.com/de-jcup ! Only 3 repositories are listed: yamleditor, sqleditor, test-generic but not this one.

OMG. I have no idea why this happened - it seems this is an issue at bintray.
Nevertheless I will migrate other plugins as soon as possible and provide a new update url at marketplace.

I think I will provide a new version until end of this week.

For details look at https://github.com/de-jcup/eclipse-asciidoctor-editor/issues/333#issuec…

 

Hello,

I love the tool but Bintray is closed for free accounts. (I had the same issue)

Can you deploy in an other container please ? (I am considering Github-page myself)

Thanks for the great job.

Nicolas

In reply to by Nicolas PERANSIN

Hello Nicolas,

Yes it's always a 401 - unauthenticated... 

When I first read https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-cha… and their later updates on their website I was pretty sure that the repository data would be still available to Mai 2022.
But it seems its only for JCenter and not for bintray parts.

For details look at https://github.com/de-jcup/eclipse-asciidoctor-editor/issues/333

 

So this becomes now very urgent. I think I will provide a new version until end of this week.

I'm trying to use C4-PlantUML via the the !include command. Unfortunately this seems to not work with Asciidoctor. I simply copied the first example from them. The example works fine if i just use PlantUML itself.

Would be great i that would work :)

 

PS: I cannot include the links to their github because links are forbidden (lol), if you google "C4-PlantUML" you should find it easily.

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...

 

In reply to by Michael Moser

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.

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

In reply to by Mario Janu

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

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)

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

In reply to by Ole Jonny Vikevry

Reproducing problem

I tried following: I downloaded https://dl.bintray.com/de-jcup/asciidoctoreditor/plugins/de.jcup.asciid… 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