Add support for GitHub Markdown Alerts #659

Closed
opened 2026-01-29 14:42:17 +00:00 by claunia · 3 comments
Owner

Originally created by @xoofx on GitHub (Feb 20, 2024).

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

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

rendered as:

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Originally created by @xoofx on GitHub (Feb 20, 2024). See https://github.com/orgs/community/discussions/16925 ```md > [!NOTE] > Highlights information that users should take into account, even when skimming. > [!TIP] > Optional information to help a user be more successful. > [!IMPORTANT] > Crucial information necessary for users to succeed. > [!WARNING] > Critical content demanding immediate user attention due to potential risks. > [!CAUTION] > Negative potential consequences of an action. ``` rendered as: > [!NOTE] > Highlights information that users should take into account, even when skimming. > [!TIP] > Optional information to help a user be more successful. > [!IMPORTANT] > Crucial information necessary for users to succeed. > [!WARNING] > Critical content demanding immediate user attention due to potential risks. > [!CAUTION] > Negative potential consequences of an action.
claunia added the enhancementPR Welcome! labels 2026-01-29 14:42:17 +00:00
Author
Owner

@jorge-moreira commented on GitHub (Feb 22, 2024):

Hi Alexandre,

The objective here is to support a new type of block (i.e. AlertBlock) with it's own parser and renderer?
For the parser I would say that there's no doubt on what to do, although for the renderer I've some doubts on how we would support this to be rendered in html.

I'll be glad to help on.

@jorge-moreira commented on GitHub (Feb 22, 2024): Hi Alexandre, The objective here is to support a new type of block (i.e. AlertBlock) with it's own parser and renderer? For the parser I would say that there's no doubt on what to do, although for the renderer I've some doubts on how we would support this to be rendered in html. I'll be glad to help on.
Author
Owner

@xoofx commented on GitHub (Mar 4, 2024):

Added a tentative PR #776 to implement this feature.

@xoofx commented on GitHub (Mar 4, 2024): Added a tentative PR #776 to implement this feature.
Author
Owner

@xoofx commented on GitHub (Mar 4, 2024):

The objective here is to support a new type of block (i.e. AlertBlock) with it's own parser and renderer? For the parser I would say that there's no doubt on what to do, although for the renderer I've some doubts on how we would support this to be rendered in html.

I'll be glad to help on.

Forgot to respond, as I was reading your question yesterday, and I started to play with a parser to see how problematic it would be to implement it and saw that it was in the end relatively small, so decided to complete the implementation. So, my apologies if I took over and thanks for the proposal for helping, I appreciate. 🙂

@xoofx commented on GitHub (Mar 4, 2024): > The objective here is to support a new type of block (i.e. AlertBlock) with it's own parser and renderer? For the parser I would say that there's no doubt on what to do, although for the renderer I've some doubts on how we would support this to be rendered in html. > > I'll be glad to help on. Forgot to respond, as I was reading your question yesterday, and I started to play with a parser to see how problematic it would be to implement it and saw that it was in the end relatively small, so decided to complete the implementation. So, my apologies if I took over and thanks for the proposal for helping, I appreciate. 🙂
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/markdig#659