Skip to content

chore(mdx): switch from md to mdx extension - #3454

Merged
thetaPC merged 11 commits into
docusaurus-mdxfrom
mdx-pt-1
Apr 19, 2024
Merged

chore(mdx): switch from md to mdx extension#3454
thetaPC merged 11 commits into
docusaurus-mdxfrom
mdx-pt-1

Conversation

@thetaPC

@thetaPC thetaPC commented Feb 15, 2024

Copy link
Copy Markdown
Contributor

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/angular/ files have been switched from .md to .mdx
  • docs/react/ files have been switched from .md to .mdx
  • docs/vue/ 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.

  • The files under the docs/api folder have been approved. There shouldn't be a need to review them again.

Angular docs
React docs
Vue docs

@vercel

vercel Bot commented Feb 15, 2024

Copy link
Copy Markdown

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 18, 2024 6:23pm

@thetaPC thetaPC changed the title chore(md): switch from md to mdx extension chore(mdx): switch from md to mdx extension Feb 15, 2024
Comment thread docs/react/quickstart.mdx

:::note
Each view must contain an `IonPage` component. Page transitions will not work correctly without it. See the [IonPage Documentation](navigation.md#ionpage) for more information.
Each view must contain an `IonPage` component. Page transitions will not work correctly without it. See the [IonPage Documentation](navigation.mdx#ionpage) for more information.

Copy link
Copy Markdown
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 correct extensions.

## From the Community

<!-- cspell:disable -->
{/* cspell:disable */}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The proper syntax for MDX.

@thetaPC
thetaPC marked this pull request as ready for review April 18, 2024 22:47
@thetaPC
thetaPC requested a review from a team as a code owner April 18, 2024 22:47
@thetaPC
thetaPC requested review from sean-perkins and removed request for a team April 18, 2024 22:47
@thetaPC
thetaPC merged commit 25f8e31 into docusaurus-mdx Apr 19, 2024
@thetaPC
thetaPC deleted the mdx-pt-1 branch April 19, 2024 15:21
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.

2 participants