fix readme syntax that caused suboptimal markdown rendering - Githubissues

bigcommerce / sample-app-nodejs

A reference implementation of a BigCommerce single-click app, in Node.JS + Next.js/React

MIT License

59 stars 340 forks source link

fix readme syntax that caused suboptimal markdown rendering #198

Closed slsriehl closed 1 year ago

slsriehl commented 1 year ago

What?

fix readme syntax that caused suboptimal markdown rendering

Why?

suboptimal markdown parser did not properly pick up the end of a fenced code block, which made part of the readme appear as though instructions were code blocks

Testing / Proof

~~https://github.com/slsriehl/sample-app-nodejs/blob/082079baaecac920cf599367db32f27201c65fa4/README.md~~ https://github.com/slsriehl/sample-app-nodejs/blob/b4a766afe447105420e809d7ff8fcfba6b94061e/README.md

@bigcommerce/api-client-developers