pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
159 stars 89 forks source link

Markdown renderer does not render GFM alerts #318

Open nfelt14 opened 2 months ago

nfelt14 commented 2 months ago

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 commented 2 months ago

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

miketheman commented 2 months ago

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

di commented 2 months ago

Version 0.29-gfm (2019-04-06)

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

miketheman commented 2 months ago

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 commented 2 months ago

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 commented 4 days ago

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: https://github.com/github/cmark-gfm/issues/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.