style: Don't convert single \n to <br>

[leonardehrenfried]

As described in #3155 we (OpenTripPlanner) tend to have quite long, multi-paragraph descriptions of our fields.

In Markdown a single \n is ignored and only two \n should lead to a new paragraph being started.

markdown-it makes this fairly easy to achieve, which is why this PR is tiny.

Before

After

I've also taken the liberty to update the dev instructions.

Many thanks for this wonderful tool!

[changeset-bot]

🦋 Changeset detected

Latest commit: a6e9612

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
graphiql	Minor
@graphiql/react	Minor
@graphiql/plugin-code-exporter	Major
@graphiql/plugin-explorer	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: leonardehrenfried / name: Leonard Ehrenfried (687b28e, ce09e53, a6e9612)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.84%. Comparing base (2348641) to head (ce09e53).
Report is 79 commits behind head on main.

❗ Current head ce09e53 differs from pull request most recent head a6e9612. Consider uploading reports for the commit a6e9612 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3414      +/-   ##
==========================================
+ Coverage   55.75%   55.84%   +0.09%     
==========================================
  Files         110      110              
  Lines        5243     5257      +14     
  Branches     1426     1433       +7     
==========================================
+ Hits         2923     2936      +13     
  Misses       1897     1897              
- Partials      423      424       +1     

Files	Coverage Δ
packages/graphiql-react/src/markdown.ts	100.00% <ø> (ø)

... and 1 file with indirect coverage changes

[acao]

@leonardehrenfried thank you for this, this is exactly how it should behave, I agree. I recall there was disagreement some years back and again with the redesign about this, I will look up some issues/discussions/? when I have more time. @thomasheyenbrock or @jonathanawesome what do you think?

one last thing, can you add a changeset as per the changset bot comment? then it'll be ready to go!

(we used to use conventional commits with lerna but contributors had issues, switched to changesets but I miss conventional commits often. i'm looking into ways to perhaps combine them, so many ways to go about it!)

[leonardehrenfried]

@acao I've added a changeset. I hope I'm bumping the right packages.

[acao]

awesome, thanks @leonardehrenfried ! I think we would make this a minor release for @graphiql/react as well

[leonardehrenfried]

Changeset was updated.

[leonardehrenfried]

Could I perhaps have another review for this?

[acao]

hey thanks for this! i'll come back to this later today or tomorrow and release it with some other new features for this @graphiql/react minor release

[leonardehrenfried]

Lovely thanks!

[leonardehrenfried]

Could I perhaps have another review for this, please?

[leonardehrenfried]

@acao Isn't this good to merge?

[acao]

sorry I hope to have more time for this in the coming months. my current commitments are for my day job and for a grant to work on the GraphQL LSP server that I'm wrapping up

[leonardehrenfried]

I totally understand. Thanks for maintaining GraphiQL!

[acao]

i think the only thing still stumping me is whether this constitutes a breaking change for some use cases, and whether there is some kind of markdown it config that solves the issue this intended to solve? maybe it was a workaround for the previous markdown library, was it marked? I need to look at the original history from, say, tag 0.7.y era or earlier to determine what the original purpose was