Skip to content

Add syntax highlight to code blocks#3345

Merged
akurtakov merged 1 commit into
eclipse-platform:masterfrom
Mailaender:syntax-highlight
Oct 2, 2025
Merged

Add syntax highlight to code blocks#3345
akurtakov merged 1 commit into
eclipse-platform:masterfrom
Mailaender:syntax-highlight

Conversation

@Mailaender
Copy link
Copy Markdown
Contributor

This creates nicer previews on GitHub and when reading documentation with @eclipse-theia.

@vogella
Copy link
Copy Markdown
Contributor

vogella commented Oct 2, 2025

@Mailaender thanks.

@merks WDYT?

@merks
Copy link
Copy Markdown
Contributor

merks commented Oct 2, 2025

The renderer for the website doesn't interpret it:

image

but the github page does:

image

But it does no harm to have it.

@akurtakov
Copy link
Copy Markdown
Member

Is such a "rendered" way deployed anywhere at all?

@merks
Copy link
Copy Markdown
Contributor

merks commented Oct 2, 2025

Is such a "rendered" way deployed anywhere at all?

I'm not sure I understand the question. Yes all the markdown content of all the project are rendered in the website.

E.g.,

https://eclipse.dev/eclipse/markdown/?file=eclipse-platform/eclipse.platform.ui/master/docs

image

@merks
Copy link
Copy Markdown
Contributor

merks commented Oct 2, 2025

@Mailaender

I don't really have time to review every line. May I trust that you've reviewed this content relatively carefully?

@akurtakov
Copy link
Copy Markdown
Member

I really missed the fact that all these markdown files are listed that way at https://eclipse.dev/eclipse/ . Thanks @merks !

@merks
Copy link
Copy Markdown
Contributor

merks commented Oct 2, 2025

One of the nice features too is that one can get a live preview of all your markdown changes (if you've used the Oomph setup for the website repository):

https://eclipse.dev/eclipse/markdown/?f=news/instructions.md#markdown-preview

@merks
Copy link
Copy Markdown
Contributor

merks commented Oct 2, 2025

I thought it good to record here that it should be possible do highlighting in the renderer too:

https://www.npmjs.com/package/marked-highlight

I just don't have the cycles for such work.

@Mailaender
Copy link
Copy Markdown
Contributor Author

I did all the changes manually, skimming through the code with Markdown preview enabled. Removed some stray new lines, and I also had trim whitespaces enabled in the editor, which is why this is a bit noisy. Sorry.

@Mailaender
Copy link
Copy Markdown
Contributor Author

@akurtakov
Copy link
Copy Markdown
Member

I went through the changes and havent' spotted anything wrong. Merging.

@akurtakov akurtakov merged commit a04181e into eclipse-platform:master Oct 2, 2025
13 checks passed
@merks
Copy link
Copy Markdown
Contributor

merks commented Oct 2, 2025

Absolutely no need to apologize. I trust that you did a good job and I am grateful! 🙏

@Mailaender Mailaender deleted the syntax-highlight branch October 2, 2025 11:30
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

Successfully merging this pull request may close these issues.

4 participants