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

chore(mdx): use mdx exts for c-d folders #3456

Merged
merged 19 commits into from
Apr 19, 2024
Merged

chore(mdx): use mdx exts for c-d folders #3456

merged 19 commits into from
Apr 19, 2024

Conversation

thetaPC
Copy link
Contributor

@thetaPC thetaPC commented Feb 15, 2024

Issue URL: N/A

What is the current behavior?

Some files are using the .md extension. Docusaurus v3 has stated that at some point that these files will no longer be parsed as expected and will parsed as CommonMark. They advice to use .mdx instead.

What is the new behavior?

  • docs/cli/ files have been switched from .md to .mdx
  • docs/contributing/ files have been switched from .md to .mdx
  • docs/core-concepts/ files have been switched from .md to .mdx
  • docs/deployment/ files have been switched from .md to .mdx
  • docs/developer-resources/ files have been switched from .md to .mdx
  • docs/developing/ files have been switched from .md to .mdx
  • Switched to the proper syntax for MDX comments.
  • Updated paths to no longer reference .md

same for v5 and v6

Does this introduce a breaking change?

  • Yes
  • No

Other information

I'm splitting these into smaller PRs to make it easier to review.

Copy link

vercel bot commented Feb 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ionic-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 19, 2024 3:38pm

@@ -13,15 +13,15 @@ The available config keys can be found in the [`IonicConfig`](#ionicconfig) inte

The following example disables ripple effects and default the mode to Material Design:

import GlobalExample from '@site/docs/developing/config/global/index.md';
import GlobalExample from '@site/docs/developing/config/global/index.mdx';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Had to update the path to use the new extension.

@thetaPC thetaPC merged commit 9a9be01 into docusaurus-mdx Apr 19, 2024
4 checks passed
@thetaPC thetaPC deleted the mdx-pt-3 branch April 19, 2024 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants