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

Add color support for badges in VM Notes (Markdown) #7614

Open
tuxpowered opened this issue Apr 29, 2024 · 5 comments
Open

Add color support for badges in VM Notes (Markdown) #7614

tuxpowered opened this issue Apr 29, 2024 · 5 comments

Comments

@tuxpowered
Copy link

tuxpowered commented Apr 29, 2024

With the addition of VM notes being supported, it would be nice to support the colorized banner

https://github.com/orgs/community/discussions/16925

https://talk.commonmark.org/t/github-is-beta-testing-their-own-admonition-syntax-we-should-weigh-in/4173/21
as a way to draw attention to special instructions that might need to be taken.

It would also be nice to have the same not functionality at the Pool and Host layer.

Use case example, You have Pool that is using shared storage, adding a in the layers (Pool, Host, VM) allows a gentle reminder that they may have some special actions to take before shutting down the service.

@pdonias
Copy link
Member

pdonias commented Apr 30, 2024

Hi, we rely on marked to parse Markdown in XO and they don't seem to be supporting those alert blocks for now.

@julien-f
Copy link
Member

IMHO, we shouldn't link notes to a specific implementation, we should only support CommonMark and broadly supported extensions.

@pdonias
Copy link
Member

pdonias commented Apr 30, 2024

Ok but even if we say we support CommonMark and even if those blocks get added to the CommonMark spec, we won't be able to render them in XO 5 until marked implements it.

@julien-f
Copy link
Member

@pdonias Maked supports a number of extensions like maked-alert.

@tuxpowered
Copy link
Author

The maked-alert is pretty much what the industry is supporting. Microsoft, Github, Obsidian. CommonMark made a comment that they will never support english word references [!WARNING] for example, however that already has push back.

[!WARNING] 
This is fire

Has much more readability than what common mark proposed

[!]

[!!]

[!*]

Giving that Github is implementing them, and oh, the repo is in git hub! it stands to reason that implementing a library that supports the extensions used here would be the most logical option.

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

No branches or pull requests

3 participants