Support GFM alerts (admonitions)

[jdtsmith]

Describe your proposed improvement and the problem it solves.

Support the new GFM Alerts (also called admonitions), which look like this:

> [!NOTE]
> This is a note

> [!CAUTION]
> This note cautions you

These could map back to org syntax #+begin_note...#+end_note and similar.

Describe alternatives you've considered.

ox-gfm, but it does not support them and seems unmaintained.

[jgm]

They are supported!

% pandoc -t native -f gfm
> [!NOTE]
> This is a note

> [!CAUTION]
> This note cautions you
[ Div
    ( "" , [ "note" ] , [] )
    [ Div ( "" , [ "title" ] , [] ) [ Para [ Str "Note" ] ]
    , Para
        [ Str "This"
        , Space
        , Str "is"
        , Space
        , Str "a"
        , Space
        , Str "note"
        ]
    ]
, Div
    ( "" , [ "caution" ] , [] )
    [ Div ( "" , [ "title" ] , [] ) [ Para [ Str "Caution" ] ]
    , Para
        [ Str "This"
        , Space
        , Str "note"
        , Space
        , Str "cautions"
        , Space
        , Str "you"
        ]
    ]
]

Currently the org writer doesn't react to this structure, but you can write a Lua filter that adds whatever special treatment you think is appropriate.

If there are standardized and obvious ways to represent these in org, we could consider implementing them in the writer. Otherwise I'd prefer to leave it up to the user to configure this through filters.

[jdtsmith]

Very cool, thanks! There is this syntax using special blocks, supported by some org-export renderers. I am interested in org read support to produce this type of structure, and write to GFM.

[jgm]

I think it should make sense to support this in both the reader and the writer.