metacpan-web icon indicating copy to clipboard operation
metacpan-web copied to clipboard

Markdown not rendering correctly

Open djzort opened this issue 5 years ago • 7 comments
trafficstars

Please compare

https://github.com/marioroy/mce-perl/blob/master/README.md

vs

https://metacpan.org/source/MARIOROY/MCE-1.872/README.md

The 3x ` seem to have problems.

djzort avatar Jun 16 '20 03:06 djzort

So, issues with code fencing.

oalders avatar Jun 16 '20 13:06 oalders

Looks like. Of course it may not be metacpan's bug as such, but rather a library

djzort avatar Jun 16 '20 15:06 djzort

It's not strictly speaking a bug. MetaCPAN is using MultiMarkdown to render the markdown, which adds some extensions over the original Markdown format. GitHub uses its own set of extensions over the original Markdown.

It would be a good idea to switch to something CommonMark compatible.

haarg avatar Jun 16 '20 19:06 haarg

I also see that bulleted (unordered) lists in my markdown are rendered without list markers or inter-item vertical space which makes a list of long items just look like indented prose. See particularly the CODE section in this document.

Source: CONTRIBUTING.md Rendered at metacpan Rendered at gitlab

(let me know if you consider this a separate issue and I'll raise one)

openstrike avatar Jun 26 '20 10:06 openstrike

That is an entirely different issue, because the style rules for markdown don't match what you want.

haarg avatar Jun 27 '20 00:06 haarg

It would be a good idea to switch to something CommonMark compatible.

Are there suggestions on a module we could switch to or does it not yet exist?

oalders avatar Jun 27 '20 17:06 oalders

FWIW CommonMark is a module on cpan

https://metacpan.org/pod/distribution/CommonMark/lib/CommonMark.pod

djzort avatar Jun 27 '20 19:06 djzort