{"id":14978515,"url":"https://github.com/electron/docs-parser","last_synced_at":"2025-04-06T00:08:34.340Z","repository":{"id":34748351,"uuid":"164378209","full_name":"electron/docs-parser","owner":"electron","description":"Parse Electron docs in a lossless way into a JSON file","archived":false,"fork":false,"pushed_at":"2024-10-26T14:08:21.000Z","size":709,"stargazers_count":22,"open_issues_count":4,"forks_count":19,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-10-29T14:58:34.511Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-07T04:28:30.000Z","updated_at":"2024-10-26T14:08:24.000Z","dependencies_parsed_at":"2023-02-17T03:45:31.299Z","dependency_job_id":"4508d453-7dca-4090-97aa-8b634e149aa7","html_url":"https://github.com/electron/docs-parser","commit_stats":{"total_commits":142,"total_committers":16,"mean_commits":8.875,"dds":0.7535211267605634,"last_synced_commit":"5bfefe0d137612742a207a0ed9f4632bcbcc8423"},"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fdocs-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fdocs-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fdocs-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fdocs-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron","download_url":"https://codeload.github.com/electron/docs-parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415967,"owners_count":20935387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:57:49.894Z","updated_at":"2025-04-06T00:08:34.315Z","avatar_url":"https://github.com/electron.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron Docs Parser\n\n[![Test](https://github.com/electron/docs-parser/actions/workflows/test.yml/badge.svg)](https://github.com/electron/docs-parser/actions/workflows/test.yml)\n[![npm version](http://img.shields.io/npm/v/@electron/docs-parser.svg)](https://npmjs.org/package/@electron/docs-parser)\n\n\u003e Generate a structured JSON API file from Electron's free-form documentation\n\n## Usage\n\n```bash\nyarn global add @electron/docs-parser\ncd ~/projects/path/to/electron/repo\nelectron-docs-parser --dir ./\n\n# You now have ./electron-api.json with the entire Electron API\n```\n\nOptions:\n* `--useReadme` - Assume all documentation is in the module's base `README.md` file \n* `--dir` - The base directory where documentation is located.\n  * API documentation must be located in `/docs/api` within the specified base directory.\n  * API structures documentation must be located in `/docs/api/structures` within the specified base directory.\n* `--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.\n\n## How it Works\n\nWe generate a markdown AST for every documentation file and search for\n\"Modules\", \"Classes\" and \"Structures\".  We then use the well documented\nand enforced [Electron docs style guide](https://github.com/electron/electron/blob/main/docs/styleguide.md) to pull the required information\nabout methods, properties and events from the generated AST.\n\nFor more information you should start your code dive in\n[`DocsParser.ts`](src/DocsParser.ts) and then probably\n[`block-parsers.ts`](src/block-parsers.ts).\n\n## TypeScript Definitions\n\nThe output of this module is used to generate TypeScript definitions for\nthe Electron API. This module itself is not used to generate those\ndefinitions - [@electron/typescript-definitions](https://github.com/electron/typescript-definitions) is.\n\nFurther, if you're looking for tooling that automatically surfaces\ntypings in GitHub PRs, you're probably looking for [Archaeologist](https://github.com/electron/archaeologist).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Fdocs-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron%2Fdocs-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Fdocs-parser/lists"}