Skip to content

Add API Docs parser to the repository #2

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
ovflowd opened this issue May 30, 2024 · 1 comment · Fixed by #33
Closed

Add API Docs parser to the repository #2

ovflowd opened this issue May 30, 2024 · 1 comment · Fixed by #33
Assignees

Comments

@ovflowd
Copy link
Member

ovflowd commented May 30, 2024

This issue concerns adding the existing API docs parser from the nodejs.dev repository to this repository.

The original files described on the source repository are:

The files above will be repurposed, changed, and updated to achieve the initial goal of:

  • Having a constants.mjs file with all sorts of constants
  • Extracting certain utils into separate files
  • Extracting Regular Expressions to a queries.mjs
  • The main logic will be extracted for now to a parser.mjs file

The initial API aim is to provide a function where the input is the VFile of an API doc, and the output is its transformed contents into MDX as a string.

This will also require a package.json and possibly a few packages to be added to the project.

@ovflowd
Copy link
Member Author

ovflowd commented Jul 5, 2024

I'm finally working on this :)

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