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: v2 docs should discourage the usage of a lower-case MDX component (will not work in v3) #8779

Merged
merged 1 commit into from
Mar 16, 2023

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Mar 16, 2023

Motivation

In MDX v2, lower-case elements can't be replaced by custom components anymore. Only the upper-case components can.

The following will stop working in Docusaurus v3, so we should start encouraging users to not use lower-case tag names for custom MDX components, even if it still temporarily works

CleanShot 2023-03-16 at 15 10 28@2x

Also did some cleanup that was related to prepare for MDX 2 (for example there's no more MDXComponents/Head component)

Test Plan

preview

Test links

https://deploy-preview-8779--docusaurus-2.netlify.app/docs/markdown-features/react#mdx-component-scope

Related issues/PRs

MDX 2 PR: #8288

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 16, 2023
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 16, 2023
@netlify
Copy link

netlify bot commented Mar 16, 2023

[V2]

Name Link
🔨 Latest commit e9e7b35
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/641324032d889c000865bd47
😎 Deploy Preview https://deploy-preview-8779--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 settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 59 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 78 🟢 100 🟢 100 🟢 100 🟢 90 Report

@slorber slorber changed the title docs: Docusaurus v2 docs should discourage the usage of a lower-case MDX component docs: v2 docs should discourage the usage of a lower-case MDX component (will not work in v3) Mar 16, 2023
@slorber slorber merged commit 88b6f5f into main Mar 16, 2023
@slorber slorber deleted the slorber/prepare-mdxcomponents-doc-for-v2 branch March 16, 2023 14:23
@github-actions
Copy link

Size Change: 0 B

Total Size: 952 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 86.2 kB
website/build/assets/css/styles.********.css 113 kB
website/build/assets/js/main.********.js 712 kB
website/build/index.html 41.1 kB

compressed-size-action

This was referenced Oct 19, 2023
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.

None yet

2 participants