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: clarify component naming for markdown import #10545

Merged
merged 3 commits into from
Oct 2, 2024

Conversation

jackrabbit128
Copy link
Contributor

@jackrabbit128 jackrabbit128 commented Oct 2, 2024

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

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

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 2, 2024
Copy link

netlify bot commented Oct 2, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 81e3d8e
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/66fdbcb316c2ac0008722ca7
😎 Deploy Preview https://deploy-preview-10545--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jackrabbit128 jackrabbit128 changed the title docs: clarify component naming for markdown import (#10542) docs: clarify component naming for markdown import Oct 2, 2024
Copy link

github-actions bot commented Oct 2, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 73 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 51 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 73 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 60 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🔴 47 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 62 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 75 🟢 100 🟢 100 🟠 86 Report

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Oct 2, 2024
Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks!

@Josh-Cena Josh-Cena merged commit 0657e58 into facebook:main Oct 2, 2024
13 checks passed
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.

Elaborate on importing markdown
3 participants