Admonitions (syntax extension)

[Omikhleia]

MkDocs' Markdown has "admonitions" as a syntax extension.

While quoting the "title" seems a bit idiosyncratic, we could support something similar:

!!! keyword Inline content for title
    4-space indented block contents...

Compare to the "fenced divs" syntax, it allows for something simpler for environments needing two arguments (where Markdown can be used in both). I mean, it's doable with fenced divs, but it looks a bit "clumsy" / less straightforward in my opinion, and also makes the task of the writer afterwards less obvious for identifying and extracting the necessary bits.

::: { .keyword }
block contents...
:::: { .title }
Content for title
::::
:::

I would tend to think it would bring a more natural way to typeset some things, with an immediate sensible use -- as shown in the PoC below.

I wonder what other writers using Markdown would have to say (or how they'd address that type of need with other means).

[Omikhleia]

But also look at how Microsoft does it for "Alerts" (https://learn.microsoft.com/en-us/contribute/markdown-reference)

> [!NOTE]
> Information the user should notice even if skimming.

So funny how everyone is tweaking Markdown in every possible direction... 👯

[Omikhleia]

And in addition to the above note on fenced dives, Pandoc also seems to have "some" of the same idea with fenced divs with just a class name:
jgm/lunamark#58

(Though it doesn't address the "title" of such blocks.)

[Omikhleia]

And yet another way, in Paradox https://developer.lightbend.com/docs/paradox/current/directives/callouts.html

@@@ note {title='Caveat Emptor'}
...
@@@

[Omikhleia]

Too many possible ways, and now that we also have Djot support, we might need to think to a better approach that just adding our own syntax extension --> switching milestones.

[Omikhleia]

For reference, admonitions in Djot are discussed here: jgm/djot#196