Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

@electron/docs-parser

0.7.1 • Public • Published

Electron Docs Parser

Generate a structured JSON API file from Electrons free-form documentation

Usage

yarn global add @electron/docs-parser
cd ~/projects/path/to/electron/repo
electron-docs-parser --dir ./
 
# You now have ./electron-api.json with the entire Electron API 

How it Works

We generate a markdown AST for every documentation file and search for "Modules", "Classes" and "Structures". We then use the well documented and enforced Electron docs style guide to pull the required information about methods, properties and events from the generated AST.

For more information you should start your code dive in DocsParser.ts and then probably block-parsers.ts.

Typescript Definitions

The output of this module is used to generate Typescript definitions for the Electron API. This module itself is not used to generate those definitions.

License

MIT

Install

npm i @electron/docs-parser

DownloadsWeekly Downloads

3,496

Version

0.7.1

License

MIT

Unpacked Size

529 kB

Total Files

29

Last publish

Collaborators

  • avatar
  • avatar