learnxinyminutes-site
learnxinyminutes-site copied to clipboard
The site's markdown rendering is significantly different from github's.
The problem
I was about to make a contribution to a page when I noticed that what I thought was a typo was actually a disparity in the way leanxinyminutes and github handle markdown.
Screenshots
learnxinyminutes:
github:
learnxinyminutes:
github:
Possible fix
I'm not a ruby programmer, but from what I dug up it might be a good idea to switch from Middleman's default RedCarpet, to something that implements github flavored markdown.
This way, both contributors and auditors could rely on/count with github's md preview, instead of cloning the site/building the site every time.
Other relevant links:
- https://about.gitlab.com/blog/2019/06/13/how-we-migrated-our-markdown-processing-to-commonmark/
- https://gitlab.com/digitalmoksha/diff_redcarpet_cmark
- https://github.com/github/cmark-gfm
- https://babelmark.github.io/
GitHub uses https://github.com/gjtorikian/commonmarker which Middleman doesn't support https://github.com/middleman/middleman/issues/2420