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-html generator (Legacy Generator) #15

Closed
ovflowd opened this issue May 31, 2024 · 0 comments · Fixed by #55
Closed

Add mdx-html generator (Legacy Generator) #15

ovflowd opened this issue May 31, 2024 · 0 comments · Fixed by #55
Assignees

Comments

@ovflowd
Copy link
Member

ovflowd commented May 31, 2024

It will take some time since we still need to create all the new API Docs Components and complete the Shiki, React, etc., migration within this repository.

To use the new tooling and ensure that we can test the generation of the API docs with this new system, we should set up a temporary mdx-html generator that generates the same layout as today.

The HTML can be a bit different underneath, but the goal is to generate (code-wise) as close as possible to the existing API docs and a visual match of both. We can even use some tools to compare how different they look/etc.

The generator would probably look as:

generators/
  mdx-html/
    index.mjs
    templates/
      index.html <-- based on https://github.com/nodejs/node/blob/main/doc/template.html
    assets/ <-- imported from https://github.com/nodejs/node/tree/main/doc/api_assets
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

1 participant