github / markup

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

RestructuredText: warning and note directives are not properly rendered #1682

Open berndschatz opened 1 year ago

berndschatz commented 1 year ago

text of warning / note directives should be rendered in a box or/and in another color.

Currently it looks like this:

note

This is a note

but it should look somehow like here -->

2023-04-11-114318_1088x130_scrot

see also --> https://sublime-and-sphinx-guide.readthedocs.io/en/latest/notes_warnings.html

IMHO this would be a big improvement for the readability of technical documentation with less effort for you for the implementation.

ichordev commented 11 months ago

Notes used to render with a little blue "info" icon, and warnings with a little yellow "warning" icon... but not anymore.

flying-sheep commented 3 months ago

Maybe this broke it? https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/

berndschatz commented 3 months ago

Maybe this broke it? https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/

This is markdown (that is designed for small blog entries), we use/need RestructuredText (that is designed for technical documentation).

flying-sheep commented 3 months ago

Hold your horses, I’m with you haha. In this community discussion, they describe that they broke the rendering for the old markdown way of doing admonitions.

What I’m implying (but could have been clear about) is that maybe they still make rST render to whatever intermediate representation the old Markdown syntax rendered to and that way broke it?

Or maybe they never supported it, I don’t remember. Since they do support admonition rendering in Markdown, they should make rST and Asciidoc admonitions render the same way.

berndschatz commented 3 months ago

Don't know what they do, the docutils works fine, so i assume they have some own stuff: post/pre-processor before / after using the docutils !? Or do they implement a complete own ResT parser !?

PS: Regarding automated testing, there are probably still a few areas for improvement for ResT (and markdown):

github-actions[bot] commented 1 day ago

Stale issue message