search

eclipse-wildwebdeveloper / wildwebdeveloper

Simple and productive Web Development Tools in the Eclipse IDE
https://projects.eclipse.org/projects/tools.wildwebdeveloper
Eclipse Public License 2.0
192 stars 71 forks source link

Markdown support #1678

Open nlisker opened 2 months ago

nlisker commented 2 months ago

Markdown is a ubiquitous syntax. Adding a renderer or syntax highlighter that shows what the resulting look is would be helpful and, in my opinion, fitting for this toolset. Mylyn WikiText exists, but consider adding your alternative for a more complete solution.

akurtakov commented 2 months ago

This project is built around language servers - so if you know of language server for editing markdown please give us a link to be evaluated. Implementing it as part of this project would mean reimplementing wikitext which would be loss of time for us.

nlisker commented 2 months ago

There is https://github.com/artempyanykh/marksman. If doing this is not worth the work then feel free to close it.

akurtakov commented 2 months ago

That's very interesting and has the potential to outsmart wikitext. IMO it's worth experimenting with standalone eclipse plugin integrating it - once usable it can be offered for inclusion here or to mylyn for easier redistribution. Are you interested in experimenting with it?

nlisker commented 2 months ago

If you mean trying out a development version, then sure.

It also occurred to me just now that in Java 23, docs can be written in Markdown: https://openjdk.org/jeps/467. This means that Eclipse has to be able to show a preview of the docs (it does so for the HTML-based once), which in turn means that maybe the JDT team already has a markdown renderer. I'll try to dig a bit into this.

nlisker commented 2 months ago

The relevant Eclipse issue is https://github.com/eclipse-jdt/eclipse.jdt.ui/issues/1472. Also https://github.com/eclipse-jdt/eclipse.jdt.core/issues/2744. Specifically, the solutions they brought up are Mylyn Wikitext and CommonMark, (https://github.com/eclipse-jdt/eclipse.jdt.ui/issues/1472#issuecomment-2211745248), with the latter existing in Orbit already (https://github.com/eclipse-jdt/eclipse.jdt.ui/issues/1472#issuecomment-2212346350), so they went with that.

Now I wonder if the solution they implemented can also be used for .md files. Needs more digging...

nlisker commented 2 months ago

Here is the reply: https://github.com/eclipse-jdt/eclipse.jdt.ui/issues/1472#issuecomment-2345861989.

mickaelistria commented 2 months ago

What are the current issues with Mylyn Wikitext for markdown edition? I think some of what it's doing (reading the file and adding styles directly on the text) is actually very good, and I don't get what Wild Web Developer could do significantly better. Can you please elaborate about the opportunities you have in mind?

nlisker commented 2 months ago

Initially I thought it would just avoid the installation of multiple features because the solutions will be concentrated in one place. But now, according to @akurtakov, there is a potential for improvement of WikiText regardless of where it's distributed.

mickaelistria commented 2 months ago

FWIW, we had some discussion with @akurtakov and the outcome is that we simply improved the TextMate themes shipped by TM4E. In the end, the generic editor with latest build of TM4E does a good job, sometimes better than wikitext.

nlisker commented 2 months ago

the outcome is that we simply improved the TextMate themes shipped by TM4E

Can you link to these changes?

mickaelistria commented 2 months ago

https://github.com/eclipse/tm4e/commit/3f557fa94b52150ca42a118fb1571a00ffe77cc7 which can be tried from https://ci.eclipse.org/tm4e/job/TM4E/job/main/lastSuccessfulBuild/artifact/org.eclipse.tm4e.repository/target/repository/

sebthom commented 1 month ago

@nlisker In combination with the TM4E/Generic Editor you can additionally install https://github.com/sebthom/previewer-eclipse-plugin which can render (GitHub Flavored) markdown.