semaphore-protocol / semaphore

A zero-knowledge protocol for anonymous interactions.
https://semaphore.pse.dev
MIT License
883 stars 193 forks source link

chore(docs): format `mdx` files #754

Closed sripwoud closed 3 months ago

sripwoud commented 4 months ago

Fix #503

prettier doesn't not have proper support for MDX v3. So we need to use another formatter to format the mdx files used for the docs website. Docusaurus recommends remark.
So this PR sets up remark in the docs apps package and uses it to format all mdx files.

Test plan

vplasencia commented 4 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?

sripwoud commented 4 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?

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

openzeppelin-code[bot] commented 4 months ago

chore(docs): format mdx files

Generated 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

sripwoud commented 4 months ago

@vplasencia ready for review