Skip to content

Add API Docs parser to the repository #2

Description

@ovflowd

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.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions