@videjs/doc-parser v0.0.2-development

Vide Docs Parser

Generate a structured JSON API file from Vide's free-form documentation

Usage

yarn global add @videjs/docs-parser
cd ~/projects/path/to/Vide/repo
videjs-docs-parser --dir ./

# You now have ./vide-api.json with the entire Vide API

Options:

• --useReadme - Assume all documentation is in the module's base README.md file
• --dir - The base directory where documentation is located.
  • API documentation must be located in /docs/api within the specified base directory.
  • API structures documentation must be located in /docs/api/structures within the specified base directory.
• --packageMode - Can be single or multi; default single. Specifying multi allows exporting multiple packages from an API instead of multiple modules from a single package.

TypeScript Definitions

The output of this module is used to generate TypeScript definitions for the Vide API. This module itself is not used to generate those definitions - @Vide/typescript-definitions is.

Further, if you're looking for tooling that automatically surfaces typings in GitHub PRs, you're probably looking for Archaeologist.

License

MIT