Skip to content

Create a reference React Doc #269

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

Closed
avivkeller opened this issue May 9, 2025 · 1 comment
Closed

Create a reference React Doc #269

avivkeller opened this issue May 9, 2025 · 1 comment

Comments

@avivkeller
Copy link
Member

avivkeller commented May 9, 2025

Before writing the code to convert our MDX into React, we should create a reference example. It doesn't need to live in this repo, but it should match the design and use @node-core/ui-components, so we can refer to it later when building the JSX generator.

See https://github.com/avivkeller/nodejs-docs-redesign-reference for an (in-progress) reference doc.

@avivkeller
Copy link
Member Author

Image


The image above shows how the plain markdown will be rendered. The goal of the reference document is to outline the transformations we need to apply to the markdown in #6 so that it matches the appearance shown in Figma.

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

No branches or pull requests

1 participant