Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix commas in code blocks of markdown #20286

Merged
merged 2 commits into from
Dec 24, 2019
Merged

Fix commas in code blocks of markdown #20286

merged 2 commits into from
Dec 24, 2019

Conversation

exclipy
Copy link
Contributor

@exclipy exclipy commented Dec 24, 2019

Description

If a comma appeared in a code block in markdown with the Remark/PrismJS plugin, it was being rendered as the string undefined. This PR fixes that so commas are now rendered as commas.

Documentation

I'll need help with updating the documentation. This bug affects Gatsby's website and it will have to be rebuilt with this fix.

Related Issues

Fixes #20270

If not specified, the parameter to Array.join is treated as ',' which resulted in commas being matched as a character that needs to be replaced by `escape-html.js` (but without a replacement specified, it was being rendered as the string 'undefined').
@exclipy exclipy requested a review from a team as a code owner December 24, 2019 11:46
Copy link
Contributor

@vladar vladar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, this is a funny bug. Thanks for noticing and fixing it! 💜

@vladar vladar added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Dec 24, 2019
@gatsbybot gatsbybot merged commit 6a49b26 into gatsbyjs:master Dec 24, 2019
@gatsbot
Copy link

gatsbot bot commented Dec 24, 2019

Holy buckets, @exclipy — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
  2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

@kinnikumegane
Copy link

kinnikumegane commented Jan 3, 2020

Hello all,
I have the same issue here using gatsby-v2-starter-lumen template.
When I write comma "," in code blocks of markdown file, it's rendered as "undefined".
Would you know how to fix it ?

How I write in markdown file

resolve: gatsby-plugin-gtag,
options: {
trackingId: process.env.GOOGLE_ANALYTICS_ID,
head: true,
anonymize: true,
}

How it's rendered in html

resolve: gatsby-plugin-gtagundefined
options: {
trackingId: process.env.GOOGLE_ANALYTICS_IDundefined
head: trueundefined
anonymize: trueundefined
}

Thanks a lot for your support !

@MarkosKon
Copy link
Contributor

This PR seems to fix the problem, but there is no version bump. As a result, the fix is not published on npm.

@thaind97git
Copy link

@vladar Seems to this PR not yet published, Right?

@vladar
Copy link
Contributor

vladar commented Jan 6, 2020

Published in [email protected]

@kinnikumegane
Copy link

kinnikumegane commented Jan 6, 2020

Thanks all for paying attention.
I got solution here, so it's fixed now on my end.

Solution;
I specify language "javascript" after three times "`", so that code block understands that it's written in javascript, and comma is rendered as comma.

```javascript

@Bizzaro
Copy link

Bizzaro commented Mar 26, 2020

awesome - just what i was looking for.
upgrading to [email protected] fixed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Commas in code blocks in markdown are rendered as "undefined"
7 participants