{"id":25837251,"url":"https://github.com/devtin/dmd-readme","last_synced_at":"2025-09-08T07:35:37.011Z","repository":{"id":42751531,"uuid":"280015983","full_name":"devtin/dmd-readme","owner":"devtin","description":null,"archived":false,"fork":false,"pushed_at":"2022-03-27T04:09:50.000Z","size":62,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-09T04:43:57.893Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devtin.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}},"created_at":"2020-07-16T00:49:24.000Z","updated_at":"2020-08-05T17:10:12.000Z","dependencies_parsed_at":"2022-09-09T22:04:22.876Z","dependency_job_id":null,"html_url":"https://github.com/devtin/dmd-readme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devtin/dmd-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devtin%2Fdmd-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devtin%2Fdmd-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devtin%2Fdmd-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devtin%2Fdmd-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devtin","download_url":"https://codeload.github.com/devtin/dmd-readme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devtin%2Fdmd-readme/sbom","scorecard":{"id":338488,"data":{"date":"2025-08-11","repo":{"name":"github.com/devtin/dmd-readme","commit":"29864e1f0c975f3aa55e47321aeaa33c2dab9bc9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/6 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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"14 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T05:15:37.277Z","repository_id":42751531,"created_at":"2025-08-18T05:15:37.278Z","updated_at":"2025-08-18T05:15:37.278Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272124753,"owners_count":24877720,"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","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-03-01T02:48:04.228Z","updated_at":"2025-08-25T20:09:20.470Z","avatar_url":"https://github.com/devtin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\u003ch1\u003edmd-readme\u003c/h1\u003e\u003c/div\u003e\r\n\r\n\u003cp\u003e\r\n    \u003ca href=\"https://www.npmjs.com/package/dmd-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/dmd-readme.svg\" alt=\"Version\"\u003e\u003c/a\u003e\r\n\u003ca href=\"https://github.com/devtin/dmd-readme/actions?query=workflow%3Atest\"\u003e\u003cimg src=\"https://github.com/devtin/dmd-readme/workflows/test/badge.svg\"\u003e\u003c/a\u003e\r\n\u003ca href=\"http://opensource.org/licenses\" target=\"_blank\"\u003e\u003cimg src=\"http://img.shields.io/badge/License-MIT-brightgreen.svg\"\u003e\u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cp\u003e\r\n    A plugin for clean readme docs\r\n\u003c/p\u003e\r\n\r\n## Installation\r\n\r\n```sh\r\n$ npm i dmd-readme --save\r\n# or\r\n$ yarn add dmd-readme\r\n```\r\n\r\n\r\n\r\n\u003cbr\u003e\u003ca name=\"Usage\"\u003e\u003c/a\u003e\r\n\r\n### Usage\r\n**Description:**\n\nPass the plug-in name to `jsdoc2md` or `dmd`:\r\r```\rjsdoc2md --plugin dmd-readme\r```\r\rThis plugin is initially a fork from dmd-readable, which:\r- removes global indexes\r- places descriptions in block-quotes\r- adds more whitespace before headings\r- changes the delimiter for multiple types in param tables to a comma\r- adds alias output\n\n\r\n\u003cbr\u003e\u003ca name=\"config\"\u003e\u003c/a\u003e\r\n\r\n### config(path) ⇒ \u003ccode\u003e\\*\u003c/code\u003e\r\n\r\n| Param | Type | Description |\n| --- | --- | --- |\n| path | \u003ccode\u003estring\u003c/code\u003e | The config path |\r\n\r\n**Description:**\n\nGrabs configuration options\n\n\r\n\u003cbr\u003e\u003ca name=\"features\"\u003e\u003c/a\u003e\r\n\r\n### features()\r\n**Description:**\n\nLoads AVA test files located `config.features`\n\n\r\n\u003cbr\u003e\u003ca name=\"pkg\"\u003e\u003c/a\u003e\r\n\r\n### pkg(key) ⇒ \u003ccode\u003e\\*\u003c/code\u003e\r\n**See**: [docs.hbs](docs.hbs) for an example of how to use this function  \n\r\n| Param | Type | Description |\n| --- | --- | --- |\n| key | \u003ccode\u003estring\u003c/code\u003e | The package property you want returned |\r\n\r\n**Description:**\n\nReads info from the package.json file.\n\n\r\n\u003cbr\u003e\u003ca name=\"prefixLines\"\u003e\u003c/a\u003e\r\n\r\n### prefixLines(string, replacer) ⇒ \u003ccode\u003estring\u003c/code\u003e\r\n\r\n| Param | Type | Description |\n| --- | --- | --- |\n| string | \u003ccode\u003estring\u003c/code\u003e | The string to modify |\r\n| replacer | \u003ccode\u003estring\u003c/code\u003e | The string to prefix to each line |\r\n\r\n**Description:**\n\nPrefixes a string to the beginning of each line in the first string\n\n\r\n\u003cbr\u003e\u003ca name=\"stripJsdocComment\"\u003e\u003c/a\u003e\r\n\r\n### stripJsdocComment(jsDocCommentBlock, replaceValue) ⇒ \u003ccode\u003eString\u003c/code\u003e\r\n\r\n| Param | Type | Description |\n| --- | --- | --- |\n| jsDocCommentBlock | \u003ccode\u003eString\u003c/code\u003e |  |\r\n| replaceValue | \u003ccode\u003eString\u003c/code\u003e | Value with to replace comment blocks |\r\n\r\n**Returns**: \u003ccode\u003eString\u003c/code\u003e - The comment without the asterisks  \n**Description:**\n\nRemoves all asterisks and additional white spaces from JSDoc comments\n\n**Example**  \n```js\nconst jsDocSyntax = `/**\n * A JSDoc description\n *\n * Hello\n **\\/`\n\n // =\u003e Outputs:\n // A JSDoc description\n //\n // Hello\n```\n\r\n\u003cbr\u003e\u003ca name=\"jsCodeToMd\"\u003e\u003c/a\u003e\r\n\r\n### jsCodeToMd(jsCode) ⇒ \u003ccode\u003estring\u003c/code\u003e\r\n\r\n| Param | Type |\n| --- | --- |\n| jsCode | \u003ccode\u003eString\u003c/code\u003e | \r\n\r\n**Description:**\n\nConverts given `jsCode` into markdown by stripping jsDoc comments\n\n\r\n* * *\r\n\r\n### License\r\n\r\n[MIT](https://opensource.org/licenses/MIT)\r\n\r\n\u0026copy; 2020-present Martin Rafael Gonzalez \u003ca href=\"mailto:tin@devtin.io\"\u003etin@devtin.io\u003c/a\u003e\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevtin%2Fdmd-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevtin%2Fdmd-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevtin%2Fdmd-readme/lists"}