{"id":13432892,"url":"https://github.com/jsdoc2md/jsdoc-to-markdown","last_synced_at":"2026-04-08T14:32:44.332Z","repository":{"id":17066861,"uuid":"19831645","full_name":"jsdoc2md/jsdoc-to-markdown","owner":"jsdoc2md","description":"Generate markdown documentation from jsdoc-annotated javascript","archived":false,"fork":false,"pushed_at":"2025-10-03T14:58:31.000Z","size":1929,"stargazers_count":1761,"open_issues_count":26,"forks_count":150,"subscribers_count":14,"default_branch":"master","last_synced_at":"2026-03-31T04:23:59.400Z","etag":null,"topics":["api-documentation","documentation","documentation-generator","documentation-tool","generator","jsdoc","jsdoc-to-markdown","markdown","readme"],"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":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-05-15T19:04:34.000Z","updated_at":"2026-03-15T17:24:42.000Z","dependencies_parsed_at":"2022-07-14T03:20:34.280Z","dependency_job_id":"4d29d643-0c21-4238-8488-a57a297f4acb","html_url":"https://github.com/jsdoc2md/jsdoc-to-markdown","commit_stats":{"total_commits":985,"total_committers":8,"mean_commits":123.125,"dds":0.009137055837563413,"last_synced_commit":"8e70b771416d2a65ceb54b820015d9f4f37be4ab"},"previous_names":["75lb/jsdoc-to-markdown"],"tags_count":135,"template":false,"template_full_name":null,"purl":"pkg:github/jsdoc2md/jsdoc-to-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-to-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-to-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-to-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-to-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsdoc2md","download_url":"https://codeload.github.com/jsdoc2md/jsdoc-to-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc2md%2Fjsdoc-to-markdown/sbom","scorecard":{"id":6897,"data":{"date":"2025-08-04","repo":{"name":"github.com/jsdoc2md/jsdoc-to-markdown","commit":"defb5c7f56032674dfec3e03d006a748215f4544"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":3.8,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":4,"reason":"5 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 1/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc2md/jsdoc-to-markdown/node.js.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc2md/jsdoc-to-markdown/node.js.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:29","Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:30","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/node.js.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENCE:0","Info: FSF or OSI recognized license: MIT License: LICENCE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T13:45:19.957Z","repository_id":17066861,"created_at":"2025-08-14T13:45:19.957Z","updated_at":"2025-08-14T13:45:19.957Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31559820,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["api-documentation","documentation","documentation-generator","documentation-tool","generator","jsdoc","jsdoc-to-markdown","markdown","readme"],"created_at":"2024-07-31T02:01:18.135Z","updated_at":"2026-04-08T14:32:44.304Z","avatar_url":"https://github.com/jsdoc2md.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Markdown","collect-all","markdown","Convert to Markdown Tools"],"sub_categories":["collect([callback], [options]) ⇒ \u003ccode\u003e[Duplex](https://nodejs.org/api/stream.html#stream_class_stream_duplex)\u003c/code\u003e ⏏","Source Code to Markdown"],"readme":"[![view on npm](https://badgen.net/npm/v/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown)\n[![npm module downloads](https://badgen.net/npm/dt/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown)\n[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=REPOSITORY)\n[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=PACKAGE)\n[![Node.js CI](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml)\n\n_Upgraders, please read the [release notes](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)_\n\n# jsdoc-to-markdown\n\nGenerates markdown API documentation from [jsdoc](https://jsdoc.app) annotated source code. Useful for injecting API docs into project README files.\n\n## Synopsis\n\n1\\. Document your code using valid jsdoc comments.\n\n```js\n/**\n * A quite wonderful function.\n * @param {object} - Privacy gown\n * @param {object} - Security\n * @returns {survival}\n */\nfunction protection (cloak, dagger) {}\n```\n\n2\\. Run a command.\n\n```sh\n$ jsdoc2md example.js\n```\n\n3\\. Get markdown output.\n\n```markdown\n## protection(cloak, dagger) ⇒ \u003ccode\u003esurvival\u003c/code\u003e\nA quite wonderful function.\n\n**Kind**: global function\n\n| Param  | Type                | Description  |\n| ------ | ------------------- | ------------ |\n| cloak  | \u003ccode\u003eobject\u003c/code\u003e | Privacy gown |\n| dagger | \u003ccode\u003eobject\u003c/code\u003e | Security     |\n\n```\n\n## Install\n\n```\n$ npm install --save-dev jsdoc-to-markdown\n```\n\n## See also\n\n* [API documentation](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)\n* The [wiki](https://github.com/jsdoc2md/jsdoc-to-markdown/wiki) for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.\n\n* * *\n\n\u0026copy; 2014-25 Lloyd Brookes \\\u003copensource@75lb.com\\\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc2md%2Fjsdoc-to-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsdoc2md%2Fjsdoc-to-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc2md%2Fjsdoc-to-markdown/lists"}