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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/long-jobs-whisper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@builder.io/qwik-city': patch
---

FIX: mdx not rendering
19 changes: 15 additions & 4 deletions packages/qwik-city/src/buildtime/markdown/mdx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import type { BuildContext } from '../types';
import { parseFrontmatter } from './frontmatter';
import { getExtension } from '../../utils/fs';
import type { CompileOptions } from '@mdx-js/mdx';
import { createHash } from 'node:crypto';
Copy link
Member

Choose a reason for hiding this comment

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

Is it ok if we rely on node here for the hash?

Math.random().toString(26).split(".").pop()

Maybe something like this is preferred

Copy link
Contributor Author

Choose a reason for hiding this comment

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

because it's in build time, I think it's OK (I also checked and this should be supported by both deno and bun)


export async function createMdxTransformer(ctx: BuildContext): Promise<MdxTransform> {
const { compile } = await import('@mdx-js/mdx');
Expand Down Expand Up @@ -69,11 +70,21 @@ export async function createMdxTransformer(ctx: BuildContext): Promise<MdxTransf
const file = new VFile({ value: code, path: id });
const compiled = await compile(file, options);
const output = String(compiled.value);
const addImport = `import { jsx } from '@builder.io/qwik';\n`;
const newDefault = `
const hasher = createHash('sha256');
const key = hasher
.update(output)
.digest('base64')
.slice(0, 8)
.replace('+', '-')
.replace('/', '_');
const addImport = `import { jsx, _jsxC, RenderOnce } from '@builder.io/qwik';\n`;
const newDefault = `
const WrappedMdxContent = () => {
const content = _createMdxContent({});
return typeof MDXLayout === 'function' ? jsx(MDXLayout, {children: content}) : content;
const content = _jsxC(RenderOnce, {children: _jsxC(_createMdxContent, {}, 3, null)}, 3, ${JSON.stringify(key)});
Copy link
Member

Choose a reason for hiding this comment

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

These are only added to the v1 codebase right? Otherwise in v2 these would break with different transform functions being used like jsxsplit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes

if (typeof MDXLayout === 'function'){
return jsx(MDXLayout, {children: content});
}
return content;
};
export default WrappedMdxContent;
`;
Expand Down
22 changes: 14 additions & 8 deletions packages/qwik-city/src/buildtime/markdown/mdx.unit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ describe('mdx', async () => {

expect(result).toMatchInlineSnapshot(`
{
"code": "import { jsx } from '@builder.io/qwik';
"code": "import { jsx, _jsxC, RenderOnce } from '@builder.io/qwik';
import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "@builder.io/qwik/jsx-runtime";
export const headings = [{
"text": "Hello",
Expand Down Expand Up @@ -60,10 +60,13 @@ describe('mdx', async () => {
})]
});
}

const WrappedMdxContent = () => {
const content = _createMdxContent({});
return typeof MDXLayout === 'function' ? jsx(MDXLayout, {children: content}) : content;
const content = _jsxC(RenderOnce, {children: _jsxC(_createMdxContent, {}, 3, null)}, 3, "eB2HIyA1");
Copy link
Member

Choose a reason for hiding this comment

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

great job on the unit test. Looks like if we do run into a problem with the transforms we'll know pretty quickly with this

if (typeof MDXLayout === 'function'){
return jsx(MDXLayout, {children: content});
}
return content;
};
export default WrappedMdxContent;
",
Expand Down Expand Up @@ -95,7 +98,7 @@ export default function Layout({ children: content }) {

expect(result).toMatchInlineSnapshot(`
{
"code": "import { jsx } from '@builder.io/qwik';
"code": "import { jsx, _jsxC, RenderOnce } from '@builder.io/qwik';
import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "@builder.io/qwik/jsx-runtime";
export const headings = [{
"text": "Hello",
Expand Down Expand Up @@ -134,10 +137,13 @@ export default function Layout({ children: content }) {
})]
});
}

const WrappedMdxContent = () => {
const content = _createMdxContent({});
return typeof MDXLayout === 'function' ? jsx(MDXLayout, {children: content}) : content;
const content = _jsxC(RenderOnce, {children: _jsxC(_createMdxContent, {}, 3, null)}, 3, "UdQmQWC3");
if (typeof MDXLayout === 'function'){
return jsx(MDXLayout, {children: content});
}
return content;
};
export default WrappedMdxContent;
",
Expand Down
Loading