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

Add mdx-react generator #6

Open
ovflowd opened this issue May 30, 2024 · 0 comments
Open

Add mdx-react generator #6

ovflowd opened this issue May 30, 2024 · 0 comments

Comments

@ovflowd
Copy link
Member

ovflowd commented May 30, 2024

Following up the extraction of the MDX parser into a dedicated generator that converts the plain Markdown into an MDX template, we should compile it into React.

This effectively introduces the react and mdx dependencies into the project. Proper ESLint and Prettier configuration for React and JSX should be added. This can be done by importing compatible rules from the Node.js Website repository.

This generator should pretty much receive the content transformed into an MDX template from the mdx generator; the MDX generator returns a VFile, with the caveat that the main content is now replaced with the MDX template, but both the metadata and file metadata remain in the VFile.

Then the mdx-react receives that VFile and pretty much compiles the MDX and evaluates it into JSX by running it with MDX https://mdxjs.com/packages/mdx/#evaluatefile-options

Hence, this generator's output is again a VFile containing the source content and the generated JSX function within the data attribute.

Note that the generated React is simply the content of the page, not the whole page (navigation, header, etc.). Think of this as the inner content of a blog post.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant