Closed
Description
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:
- https://github.com/nodejs/nodejs.dev/blob/main/util-node/apiDocsTransformUtils.js
- https://github.com/nodejs/nodejs.dev/blob/main/util-node/apiDocsTypeParser.js
- https://github.com/nodejs/nodejs.dev/blob/main/scripts/syncApiDocs.js
- https://github.com/nodejs/nodejs.dev/blob/main/util-node/getApiDocsData.js
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.
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Done