Closed sripwoud closed 3 months ago
Hey! Thanks for testing it. Could you try cd apps/docs
and then yarn start
and let me know if you can see the docs website without any issues?
Hey! Thanks for testing it. Could you try
cd apps/docs
and thenyarn start
and let me know if you can see the docs website without any issues?
Right, it indeed breaks the build. But I find a way to both format the mdx file and have a working build.
And we have another issue I captured here #756 : the ci should have detected this PR broke the build at first
mdx
filesGenerated at commit: 40f2e153807be33e57f4897235ecd1b359295a73
🚨 Report Summary
Severity Level Results Contracts Critical High Medium Low Note Total 0 0 0 4 16 20 Dependencies Critical High Medium Low Note Total 0 0 0 0 0 0
For more details view the full report in OpenZeppelin Code Inspector
@vplasencia ready for review
Fix #503
prettier
doesn't not have proper support for MDX v3. So we need to use another formatter to format themdx
files used for the docs website. Docusaurus recommendsremark
.So this PR sets up remark in the docs apps package and uses it to format all mdx files.
Test plan
yarn format
should be successfulmdx
file:yarn format:write
should reformat it correctlyyarn workspace semaphore-docs start
: should start the server without warnings or errors