theia-ide / theia-asciidoc-extension

Asciidoctor extension for Theia

Asciidoc Extension for Theia

An extension for Theia, to support Asciidoc syntax coloring and rendering of previews.

You can test the extension through: https://gitpod.io/#https://github.com/theia-ide/theia-asciidoc-extension

And running the following in the terminal:

yarn && cd browser-app/ && yarn start --hostname 0.0.0.0 ..

theia-asciidoc-extension's Issues

Support the asciidoctor-diagram extension

Asciidoctor supports diagrams using the block syntax, e.g.
[plantuml]
....
here is the PlantUML diagram code
....
But this is not supported by the asciidoctor extension's backend.

If you install the asciidoctor-diagram extension in the docker file using "gem install asciidoctor-diagram" and use the require option (-r): -r asciidoctor-diagram in the shell call, diagram images should be generated (in the same folder as html file) and could be served by the backend.

package.json should state a license

this would make it easier for down-stream projects to conduct their license compliance validation.

Preview doesn't work in gitpod.io

I've opened an .adoc-File and got the following error message in the preview:

/bin/sh: 1: asciidoctor: not found

I tried to open this extension in an gitpod, and got the following error message:

I'd expected the preview to work in a normal GitPod IDE

Translate relative links

Relative links need to be translated to be rendered correctly

Send errors and warnings as diagnostics

Currently, we are rendering any errors and warnings in the preview.
We should connect a language service that translates them into diagnostics and runs even without previews being open.

includes do not work

great work! The preview already looks great!

while testing the extension, I noticed two things with includes:

include::test.adoc[]

1. this throws an error and doesn't render the document at all. Other implementations just render the error instead of the included file.

The error is

asciidoctor: ERROR: contents.adoc: line xxx: include file not found: /tmp/asciidoc-hhY0dg/test.adoc

2. as you can see, it seem that the error is because the extension tries to find the document to be included in the /tmp folder. This might be because include files are document relative... so if you render the main document in /tmp, it will also search the included files there.

If I rewrite the include from above as

include::/workspace/theia-asciidoc-extension/test.adoc[]

everything works fine

Pretty print code

We need to include prettify

[scroll-sync] Add source maps

The :sourcemap option has no CLI equivalent.

But, there is an extension to Asciidoctor: https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/lib/enable-sourcemap-preprocessor.rb

Even if it's external to the generated HTML, we could use this to hook up the scroll-sync.