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.

MD038 suggested fixes do not render well on GitHub. Or, I misunderstand their purpose.

See original GitHub issue

What I want is a block of text that my user’s can copy from a markdown file that includes a trailing space. E.g., something like

"prefix - "

The double quotes are to show what I want and to show that GitHub markdown renders the trailing space.

Specifically, this from MD038 - Spaces inside code span elements

Note: A single leading and trailing space is allowed by the specification and automatically trimmed (to allow for embedded backticks):

`backticks` Note: A single leading or trailing space is allowed if used to separate code span markers from an embedded backtick:

` embedded backtick

The first example displays the a backtick, the text, and a backtick:

`backticks`

The second displays a backtick, followed by a space, followed by the text:

` embedded backtick

Other than ignoring the warning, another workaround is

prefix - 
as shown here. But, at least on GitHub, that introduces a line break that I don’t want.

Finally, the markdown preview in VS Code 1.73.1 appears to render these the same as GitHub, itself.

Issue Analytics

  • State:closed
  • Created 10 months ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
DavidAnsoncommented, Nov 18, 2022

I’ll add a bit to the role description to try to explain this. Thanks.

1reaction
DavidAnsoncommented, Nov 17, 2022

MD038 exists to help authors avoid accidentally including a space on either edge of an inline code span. If you specifically want to include a space, you probably want to suppress this rule because its guidance does not apply.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Issues · DavidAnson/markdownlint · GitHub
A Node.js style checker and lint tool for Markdown/CommonMark files. ... MD038 suggested fixes do not render well on GitHub. Or, I misunderstand...
Read more >
SAS CDISC proceedings - Lex Jansen
PP01 SEND Dataset QC Best Practices - Common explanations for FDA / CDISC validation ... CT10 When PROC COMPARE is Not Enough –...
Read more >
DavidAnson Markdownlint Issues - IssueHint
DavidAnson Markdownlint: A Node.js style checker and lint tool for Markdown/CommonMark files. ... MD038 suggested fixes do not render well on GitHub.
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