search

betterscientificsoftware / bssw.io

Better Scientific Software Homepage
https://bssw.io
Other
137 stars 88 forks source link

Can we make markdown rendering on bssw.io closer to what most authoring tools use? #706

Open bernhold opened 3 years ago

bernhold commented 3 years ago

At present, the renderings of markdown content available to contributors from GitHub's UI and other easily authoring tools can sometimes be significantly different from what they'll see on the preview (or production) site. It would be easier on contributors and our editors if they were closer. (At least specific markdown elements should be rendered similarly.)

At present, we're pretty sure that the front-end uses a different flavor of Markdown than GitHub, and we know that the CSS for the site is rather different than the default that most authoring tools us. It would be nice to systematically move them closer together.

bernhold commented 3 years ago

A challenge with changing the front-end's Markdown processor or CSS is that we already have a lot of content using what's currently there. We'd need to make sure old content transitions smoothly, which could be challenging.

An alternative might be to add a metadata tag to all existing content indicating that it uses "old rendering" and apply different CSS (maybe even different markdown processors?) depending on the metadata setting.

bernhold commented 2 years ago

Ross encountered problems with greater and less-than symbols (<>) being stripped out, even in blocks that are supposed to be taken verbatim. See here: https://github.com/betterscientificsoftware/bssw.io/pull/1156#issuecomment-999063412