react-scripts README template contains <br> which shows on BitBucket as text (non-valid markdown code)

Not sure if if it’s bug report. I wanted to create PR right away, but then I found closed PR: https://github.com/facebook/create-react-app/pull/1393 which added <br> explicitly. @gaearon commented it was good.

I did npm init react-app my-new-app, and it created, all works fine. Here is piece from package.json:

"dependencies": {
    "react": "^16.8.6",
    "react-dom": "^16.8.6",
    "react-scripts": "3.0.1"
  },

But README.md file does contain non-markdown code, which affects how readme shown on BitBucket:

I looked up files:

https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md

https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template-typescript/README.md

and they indeed contain <br>.

I work with ReactJS ~2 years, but I faced with using react-scripts first time last year, and the issue persist since then. Coz I have old instance (Oct-2017) and new instance (May-2019) of create-react-app.

Both are rendered/shown on GitHub properly. Here is my README files from those 2 instances:

• old - Oct-2018
• new - May-2019

And BitBucket renders both with <br> as text (assumable it’s not proper markdown code). Here are BitBucket examples (public):

• https://bitbucket.org/alundiak/test-del-me-later/src/master/

So the issue is ONLY for BitBucket representation of README/markdown code.

[heyimalex]

From discussion here it looks like we might be able to change them to forward slashes. Would you check whether bitbucket supports this syntax? It works on github and gitlab.

hello\
world

We also need to see if it works on npm I suppose.

[heyimalex]

@alundiak Trailing two whitespaces is the canonical way to do line breaks in markdown. I’ve created a snippet trying all versions and it’s the only way that works.

I’ve opened an issue at bitbucket for making the backslash syntax work, and there’s another issue open for supporting html.

From reading the other issues in their tracker, it looks like their markdown support is pretty basic/partial, so I’m sure it’ll be revisited soon. I’d rather wait for bitbucket to change to at least support the backslash syntax before creating a change here. So I’m closing this as bitbucket’s problem.