Skip to content
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

Merged
merged 11 commits into from
Oct 29, 2021

Conversation

cerkiewny
Copy link
Contributor

@cerkiewny cerkiewny commented Oct 21, 2021

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/

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 21, 2021
@netlify
Copy link

netlify bot commented Oct 21, 2021

✔️ [V2]
Built without sensitive environment variables

🔨 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

@github-actions
Copy link

github-actions bot commented Oct 21, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 67
🟢 Accessibility 98
🟢 Best practices 93
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-5766--docusaurus-2.netlify.app/

@Josh-Cena
Copy link
Collaborator

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 slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Oct 27, 2021
Copy link
Collaborator

@slorber slorber left a 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

@cerkiewny cerkiewny force-pushed the feature/mdx_docs branch 2 times, most recently from 973746d to 7360d50 Compare October 27, 2021 13:31
Copy link
Collaborator

@slorber slorber left a 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

@Josh-Cena
Copy link
Collaborator

@cerkiewny Does the new writeup make sense to you? Is there any other reminder that you want to mention?

@cerkiewny
Copy link
Contributor Author

@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.

@Josh-Cena Josh-Cena changed the title docs: Create more descriptive introduction to markdown plugins docs: elaborate on the usage of MDX plugins Oct 29, 2021
@slorber
Copy link
Collaborator

slorber commented Oct 29, 2021

Thanks, that looks better and consistent 👍 we can always improve a bit more later

@slorber slorber merged commit dc5a0b7 into facebook:main Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation on remark / rehype plugins
4 participants