{"id":13432889,"url":"https://github.com/jsdoc2md/jsdoc-parse","last_synced_at":"2025-04-04T15:10:07.370Z","repository":{"id":45523521,"uuid":"21709672","full_name":"jsdoc2md/jsdoc-parse","owner":"jsdoc2md","description":"parses jsdoc documentation from javascript or html files, outputs JSON","archived":false,"fork":false,"pushed_at":"2024-01-31T18:43:07.000Z","size":391,"stargazers_count":94,"open_issues_count":5,"forks_count":19,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-15T12:51:33.108Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/jsdoc2md.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-07-10T20:43:39.000Z","updated_at":"2024-06-18T12:40:36.263Z","dependencies_parsed_at":"2024-01-31T19:52:15.247Z","dependency_job_id":null,"html_url":"https://github.com/jsdoc2md/jsdoc-parse","commit_stats":{"total_commits":282,"total_committers":4,"mean_commits":70.5,"dds":"0.010638297872340385","last_synced_commit":"013bd2dc3925b433382a7ff0b68b4ce05219a34a"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-parse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-parse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-parse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-parse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsdoc2md","download_url":"https://codeload.github.com/jsdoc2md/jsdoc-parse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198463,"owners_count":20900080,"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-07-31T02:01:18.105Z","updated_at":"2025-04-04T15:10:07.336Z","avatar_url":"https://github.com/jsdoc2md.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![view on npm](https://badgen.net/npm/v/jsdoc-parse)](https://www.npmjs.org/package/jsdoc-parse)\n[![npm module downloads](https://badgen.net/npm/dt/jsdoc-parse)](https://www.npmjs.org/package/jsdoc-parse)\n[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-parse)](https://github.com/jsdoc2md/jsdoc-parse/network/dependents?dependent_type=REPOSITORY)\n[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-parse)](https://github.com/jsdoc2md/jsdoc-parse/network/dependents?dependent_type=PACKAGE)\n[![Node.js CI](https://github.com/jsdoc2md/jsdoc-parse/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-parse/actions/workflows/node.js.yml)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)\n\n# jsdoc-parse\n\nTransforms [jsdoc](https://github.com/jsdoc3/jsdoc) data into something more suitable for use as template input. Also adds a few tags to the default set:\n\n* Support for new tags in the input javascript\n  * `@category \u003cstring\u003e`: Useful for grouping identifiers by category.\n  * `@done`: Used to mark `@todo` items as complete.\n  * `@typicalname`: If set on a class, namespace or module, child members will documented using this typical name as the parent name. Real-world typical name examples are `$` (the typical name for `jQuery` instances), `_` (underscore) etc.\n  * `@chainable`: Set to mark a method as chainable (has a return value of `this`).\n\n## Command-line usage\n\nThis module is built into [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown/), you can see the output using this command:\n\n```\n$ jsdoc2md --json \u003cfiles\u003e\n```\n\n* * *\n\n\u0026copy; 2014-24 Lloyd Brookes \\\u003c75pound@gmail.com\\\u003e.\n\nTested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc2md%2Fjsdoc-parse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsdoc2md%2Fjsdoc-parse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc2md%2Fjsdoc-parse/lists"}