Markdown renderer does not render GFM alerts

[nfelt14]

The alerts that display on the main page of the repository are not displaying properly on PyPI

GitHub: https://github.com/tektronix/tm_devices
PyPI: https://pypi.org/project/tm-devices/

[di]

More context here: https://github.com/orgs/community/discussions/16925

[miketheman]

I haven't seen these be added to the GFM spec yet.

[di]

Version 0.29-gfm (2019-04-06)

Not sure if we'll see it happen...

[miketheman]

FWIW, they do update their code without necessarily updating the spec, and we're on the latest release: https://github.com/github/cmark-gfm/releases/tag/0.29.0.gfm.13

[nfelt14]

FWIW, they do update their code without necessarily updating the spec, and we're on the latest release: https://github.com/github/cmark-gfm/releases/tag/0.29.0.gfm.13

I kind of thought it was something like this, unfortunately.

[flying-sheep]

According to @wooorm, this stuff will never be part of the spec, because it’s a GitHub postprocessing feature and not a syntax feature (source: github/cmark-gfm#350)

Since most of the the other postprocessing stuff is GitHub specific (like linking PRs and so on), I doubt it’s in scope to implement it here.

[biblicabeebli]

Important

This feature rocks, and it exists in the world right now as a de-facto standard due to it's own inertia from being great. And github already adopted it.

It has been a year+ since the original post here, I think the feature was proposed+introduced in 2023.

Github (or someone who works there) appears to be sitting on this one for obscure technical/legalistic reasoning: it's at the wrong stage in the rendering pipeline, and therefore it cannot be considered "new syntax", and as such we can't ever even speculate upon the merest inkling of it going in the spec because that would shatter reality. This is not the appropriate legalistic argument we should look to.

Imo this discussion should shift to one of technical difficulty and roadblocks.

This is a weird situation where there's an argument on each side about how Pypi probably should be a follower not a leader, but on the other hand it's probably both easy and good and some of us want it, plus it's already in heavy use.

Great features should be adopted eventually... so I hereby propose that it is now eventually and we should go ahead and install the plugin.

(... what a weird definitional treatment of syntax...)

---

Here's two reference plugins, I won't pretend to know the tech stack here:

• https://github.com/dahlia/markdown-gfm-admonition
• https://github.com/KyleKing/mdformat-gfm-alerts

I cannot tell if these are a meant to be called admonitions or alerts. it looks like commonmark may call them admonitions