CPColin / ceylon.markdown

A port of the commonmark.js Markdown parser and renderer to Ceylon
Apache License 2.0
5 stars 0 forks source link

Investigate using new module in IDE plugin(s) #25

Open CPColin opened 6 years ago

CPColin commented 6 years ago

The IDE plugins currently use the txtmark library to process Ceylon documentation. Look into using the ceylon.markdown module for this purpose. Don't worry about moving functionality to the common code, for now; just try to get a plugin built as a proof of concept.

See: https://github.com/eclipse/ceylon-ide-eclipse/blob/master/plugins/org.eclipse.ceylon.ide.eclipse.ui/source/org/eclipse/ceylon/ide/eclipse/module.ceylon

gavinking commented 6 years ago

Look into using the ceylon.markdown module for this purpose.

Yes, that would be very interesting!

CPColin commented 6 years ago

Looking at the ceylon-ide-intellij source, it looks like we're going to need to supply a custom code block renderer in ceylon.markdown. Right now, the only customization is for special links, so we'll need to add some default annotations here and there.

CPColin commented 6 years ago

Side effect of adding those default annotations: copying the README into module.ceylon, so the Herd listing says something interesting now: https://herd.ceylon-lang.org/modules/ceylon.markdown/1.1.0

CPColin commented 6 years ago

Just posted to the Gitter, but it looks like ceylon-ide-intellij/build.xml manually specifies modules that the plugin needs at runtime. It doesn't appear to have a way to grab such modules from the Herd, so the end result is that we can compile the plugin just fine, but we get a ClassNotFoundException as soon as IDEA tries to show any documentation.