-
-
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: clarify component naming for markdown import #10545
Merged
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
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
jackrabbit128
changed the title
docs: clarify component naming for markdown import (#10542)
docs: clarify component naming for markdown import
Oct 2, 2024
⚡️ Lighthouse report for the deploy preview of this PR
|
Josh-Cena
reviewed
Oct 2, 2024
website/docs/guides/markdown-features/markdown-features-react.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Joshua Chen <[email protected]>
Josh-Cena
added
the
pr: documentation
This PR works on the website or other text documents in the repo.
label
Oct 2, 2024
Josh-Cena
approved these changes
Oct 2, 2024
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.
👍 Thanks!
Josh-Cena
reviewed
Oct 2, 2024
website/docs/guides/markdown-features/markdown-features-react.mdx
Outdated
Show resolved
Hide resolved
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.
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.
Pre-flight checklist
Motivation
As someone who barely knows any Javascript, I did not succeed in importing a markdown document from an mdx one. Adding the proposed clarification would have saved me some time and frustration.
Test Plan
It is a documentation change. I verified it using github's markdown preview.
Test links
Deploy preview: https://deploy-preview-10545--docusaurus-2.netlify.app/docs/markdown-features/react/#importing-markdown
Related issues/PRs
Fixes #10542