Feature request - add Admonitions/Callouts

[spidzi]

Is your feature request related to a problem? Please describe.

I would like to see something similar to Obsidian Callouts (aka Admonitions) - text blocks with colored background for short additional info (info/note, warning, example,...).
It is a very standard element in wiki-like documentation and it would help a lot to "to include additional content without breaking the flow of your notes".

Describe the solution you'd like

Examples:

• Obsidian Callouts
• Gitlab documentation

Basic functionality:

• several basic types (note, warning, example,...)
• render as block with colored background (different for each type)
• icon or text identifying the type

First version does not need to have all the bells and whistles like folding and nesting.

Describe alternatives you've considered

Custom CSS and HTML? Not nice.
Quote markdown element. Not systematic.

Screenshots or Videos

[riccardoferretti]

I am not against adding it into Foam for a coherent experience, even if strictly speaking I wouldn't say this falls within Foam's scope, but more within a VS Code plugin that enhances the markdown preview.

Happy to take in thoughts and feedback

[riccardoferretti]

As a reference, markdown-it already has a plugin that supports admonitions, although these use a different syntax:

https://github.com/commenthol/markdown-it-admon

This is one of the reasons why I am hesitant in having this in Foam itself, as there are several flavors and opinions on md syntax. Foam is focused on the networked aspect of the knowledge base, and tries to be as little opinionated as possible about the rest.