Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown support #1678

Open
nlisker opened this issue Sep 12, 2024 · 12 comments
Open

Markdown support #1678

nlisker opened this issue Sep 12, 2024 · 12 comments

Comments

@nlisker
Copy link

nlisker commented Sep 12, 2024

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
Copy link
Contributor

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
Copy link
Author

nlisker commented Sep 12, 2024

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

@akurtakov
Copy link
Contributor

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
Copy link
Author

nlisker commented Sep 12, 2024

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
Copy link
Author

nlisker commented Sep 12, 2024

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

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

@nlisker
Copy link
Author

nlisker commented Sep 12, 2024

Here is the reply: eclipse-jdt/eclipse.jdt.ui#1472 (comment).

@mickaelistria
Copy link
Contributor

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
Copy link
Author

nlisker commented Sep 20, 2024

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
Copy link
Contributor

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
Copy link
Author

nlisker commented Sep 21, 2024

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

Can you link to these changes?

@mickaelistria
Copy link
Contributor

eclipse-tm4e/tm4e@3f557fa which can be tried from https://ci.eclipse.org/tm4e/job/TM4E/job/main/lastSuccessfulBuild/artifact/org.eclipse.tm4e.repository/target/repository/

@sebthom
Copy link
Contributor

sebthom commented Oct 23, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants