-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: elaborate on the usage of MDX plugins #5766
Conversation
✔️ [V2] 🔨 Explore the source changes: a5aeb33 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/617a7afd0f47ee000700f1d9 😎 Browse the preview: https://deploy-preview-5766--docusaurus-2.netlify.app |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5766--docusaurus-2.netlify.app/ |
Perhaps also linking to Docusaurus's own Remark plugins? https://github.com/facebook/docusaurus/tree/main/packages/docusaurus-mdx-loader/src/remark Also mention in what cases may users want to create a Remark plugin (a common one: when they want to transform a node into something else other than the default one) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some sentences feel a bit weird, duplicate, or too long/complex.
Please try to write something more concise, to the point, and consistent with the rest of the doc
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
973746d
to
7360d50
Compare
7360d50
to
01305b3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems better but some things are wrong
Also I'm not a native English speaker but I think there are some grammatical issues
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
website/docs/guides/markdown-features/markdown-features-plugins.mdx
Outdated
Show resolved
Hide resolved
@cerkiewny Does the new writeup make sense to you? Is there any other reminder that you want to mention? |
Makes sense, I see you have added the section creating example plugin which for sure helps. |
Thanks, that looks better and consistent 👍 we can always improve a bit more later |
Motivation
Fixes #5492
Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
Document only change - manual tests. Preview link: https://deploy-preview-5766--docusaurus-2.netlify.app/docs/next/markdown-features/plugins/