@electron/docs-parser
Advanced tools
Generate a structured JSON API file from Electron's free-form documentation
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
Options:
--useReadme - Assume all documentation is in the module's base README.md file--dir - The base directory where documentation is located.
/docs/api within the specified base directory./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.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.
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 - @electron/typescript-definitions is.
Further, if you're looking for tooling that automatically surfaces typings in GitHub PRs, you're probably looking for Archaeologist.
MIT
FAQs
Parse Electron documentation into a machine readable JSON file
The npm package @electron/docs-parser receives a total of 0 weekly downloads. As such, @electron/docs-parser popularity was classified as not popular.
We found that @electron/docs-parser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Security News
Socket has released a free Certified Patch for a critical Rails Active Storage vulnerability, giving developers time to upgrade to a secure Rails version.
Security News
/Threat Research
A malicious Ruby gem runs a credential-stealing worm during installation, poisons AI coding tools, and can wipe files when a stolen GitHub token is revoked.
Security News
GitHub is tightening GitHub Actions security with new restrictions on privileged pull request workflows. Here's what changes and how maintainers are affected.