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

fix mdx not rendering #7168

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix mdx not rendering #7168

wants to merge 1 commit into from

Conversation

shairez
Copy link
Contributor

@shairez shairez commented Dec 16, 2024

What is it?

  • Bug

Description

For some reason, the Qwik UI docs didn't render with version 1.10.0 because they are based on mdx.

Apparently #6845 broke it.
But this seems to fix it.

Couldn't setup a breaking test for this one (it happens only in dev mode, and the CLI e2e passed with my attempt to break it).

It also seems like this is solved in V2, so this will be a quick (qwik) fix until V2 is released and then we'll dig into it more.

Checklist

@shairez shairez requested a review from a team as a code owner December 16, 2024 00:23
Copy link

changeset-bot bot commented Dec 16, 2024

🦋 Changeset detected

Latest commit: eb47d90

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@builder.io/qwik-city Patch
eslint-plugin-qwik Patch
@builder.io/qwik Patch
create-qwik Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@shairez shairez self-assigned this Dec 16, 2024
Copy link

pkg-pr-new bot commented Dec 16, 2024

Open in Stackblitz

npm i https://pkg.pr.new/@builder.io/qwik@7168
npm i https://pkg.pr.new/@builder.io/qwik-city@7168
npm i https://pkg.pr.new/eslint-plugin-qwik@7168
npm i https://pkg.pr.new/create-qwik@7168

commit: eb47d90

@maiieul
Copy link
Contributor

maiieul commented Dec 16, 2024

@shairez I'm not sure this is necessary. The Qwik UI docs use an mdx recma plugin hack that I implemented back then. So your fix here would be fixing a hack inside of Qwik UI in a way 😅. I got the Qwik UI docs to work by simply removing the plugin. This seems to work now since Woot changed the underlying implementation. I was going to make a PR, but no time for it when I was in China 🙈

@shairez
Copy link
Contributor Author

shairez commented Dec 16, 2024

thanks @maiieul
well that explains the tests passing 😅

closing

@shairez shairez closed this Dec 16, 2024
@shairez shairez reopened this Dec 23, 2024
Copy link
Contributor

github-actions bot commented Dec 23, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
qwik-docs ✅ Ready (View Log) Visit Preview eb47d90

@shairez
Copy link
Contributor Author

shairez commented Dec 23, 2024

Re-opening after discussion with Maieul

@shairez shairez enabled auto-merge December 23, 2024 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants