chore(docs): format mdx files
#754
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sripwoud
added
documentation 📖
|
Hey! Thanks for testing it. Could you try |
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 |
sripwoud
force-pushed
the
fix/format-mdx
branch
2 times, most recently
from
065cfa3
to
3c2ccf1
Compare
chore(docs): format
|
| 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
force-pushed
the
fix/format-mdx
branch
from
3c2ccf1
to
1f7842d
Compare
|
@vplasencia ready for review |
sripwoud
force-pushed
the
fix/format-mdx
branch
from
1f7842d
to
c4cb471
Compare
sripwoud
commented
Apr 26, 2024
vplasencia
reviewed
Apr 28, 2024
`prettier` doesn't not have proper support for MDX v3. Docusaurus recommends using `remark` instead. https://docusaurus.io/docs/markdown-features/react re #503
sripwoud
force-pushed
the
fix/format-mdx
branch
from
c79f626
to
40f2e15
Compare
vplasencia
approved these changes
Apr 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #503
prettierdoesn't not have proper support for MDX v3.So we need to use another formatter to format the
mdxfiles 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
yarn formatshould be successfulmdxfile:yarn format:writeshould reformat it correctlyyarn workspace semaphore-docs start: should start the server without warnings or errors