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) |
slorber
left a comment
There was a problem hiding this comment.
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
973746d to
7360d50
Compare
7360d50 to
01305b3
Compare
slorber
left a comment
There was a problem hiding this comment.
Seems better but some things are wrong
Also I'm not a native English speaker but I think there are some grammatical issues
|
@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 |
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
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/