github / markup

Determines which markup library to use to render a content file (e.g. README) on GitHub
MIT License
5.88k stars 3.4k forks source link

Feature Request: Admonitions/Notices #1256

Open matchavez opened 5 years ago

matchavez commented 5 years ago

Feature Request: Admonitions/Notices

Admonitions (rST) or "notices" are a common use of documentation, and would be a welcome addition to the GFM specification. I would submit that the change could be simplified in the same way as noted in https://github.com/getgrav/grav-plugin-markdown-notices.

! This is a warning notification

!! This is a error notification

!!! This is a default notification

!!!! This is a success notification

As seen in approximation by:

screenshot

The Exclamation-Space would differ from any image processing based on the space, but no matter how it is implemented, find a way such that these notices are rendered in the way that would be expected in common documentation.

Thanks.

github-actions[bot] commented 6 days ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.