question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Dockstore entry markdown decides "this is a bullet point" differently from GitHub markdown

See original GitHub issue

Describe 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: git

dockstore: 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:open
  • Created a year ago
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
aofarrelcommented, Sep 12, 2022

@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.

0reactions
unito-botcommented, Dec 16, 2022

➤ Charles Overbeck commented:

Steve idea: consider translating to something the library understands

Read more comments on GitHub >

github_iconTop Results From Across the Web

Bullet points in hover markdown not rendered on GitHub #1510
Guessing this is a CSS issue, not an extensions rendering issue, so relabeled to browser-extension . All reactions.
Read more >
Formatting your text with Markdown - Pivotal Tracker
Formatting your text with Markdown. Tracker uses a version of Markdown (“Tracker-Flavored Markdown”) for description, comments, tasks, blockers and titles.
Read more >
How to link to a bullet point within a section in markdown
I am making a readme file for my GitHub project and need to link to a specific bullet point within a specific section...
Read more >
Readme: the file type simply explained with examples - IONOS
You can create bullet points in an unordered list in markdown format using an asterisk “*” at the beginning of the line. Links...
Read more >
Don't write documentation in Markdown | Hacker News
On GitHub, cross-reference is easy enough with links (ala hyperlinks) using relative paths. On LeanPub, I can add notes and references with ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found