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

Feature request: highlight code blocks in descriptions (markdown) #18043

Open
fuzmish opened this issue Sep 29, 2024 · 0 comments
Open

Feature request: highlight code blocks in descriptions (markdown) #18043

fuzmish opened this issue Sep 29, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@fuzmish
Copy link
Contributor

fuzmish commented Sep 29, 2024

Is your feature request related to a problem? Please describe.
Currently, any description field for any entity on the UI can be set in markdown, but if we write code blocks, it just show up as plaintext and no syntax highlight will be applied.
We are considering to put a document with sample code in the description as design information for the data. It helps a lot if the code is highlighted.

Describe the solution you'd like
There are various libraries for highlighting (such as highlight.js, Codemirror).
So we can use them to extend markdown rendering.

Describe alternatives you've considered
None.

Additional context
None.

@fuzmish fuzmish added the enhancement New feature or request label Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant