Dockstore entry markdown decides "this is a bullet point" differently from GitHub markdown
See original GitHub issueDescribe the bug One of my github-app workflows has a readme with bullet points and bold text. On GitHub the readme renders as expected, but on Dockstore a piece of bold text is being misinterpreted as another bullet point + italics.
The general pattern seems to be:
*foo*
* foo 1
* foo 2
*bar*
* bar 1
* bar 2
GitHub: “bar is not a bullet point.” Dockstore: “bar is a bullet point.”
To Reproduce The formatting above should trigger the issue, but if not, here’s the problematic readme in question.
Expected behavior Markdown is weird and doesn’t work the same everywhere, but ideally we should try to match GitHub’s version (at least when an entry is pulling from a GH-hosted README.md). Even if we put aside GitHub, I think the fact there is two newlines between the last bullet point and the next piece of text should not result in a bullet point in markdown.
Screenshots
github:
dockstore:
Additional context Webservice - 1.12.2
UI - 2.9.2
Compose Setup - 1.12.2
Deploy - 1.12.6
galaxyParsingLambdaVersion: 0.0.7
┆Issue is synchronized with this Jira Story ┆Fix Versions: Dockstore 1.14 ┆Issue Number: DOCK-2244 ┆Sprint: 102 - Dutchman, The Flying ┆Issue Type: Story
Issue Analytics
- State:
- Created a year ago
- Comments:7 (5 by maintainers)
Top GitHub Comments
@denis-yuen I think this is actually a bug – it seems that commonmark would render the same way as GFM in this case, which would mean that our commonmark implementation isn’t working correctly.
➤ Charles Overbeck commented:
Steve idea: consider translating to something the library understands