{"id":28573705,"url":"https://github.com/remarkjs/remark-comment-config","last_synced_at":"2025-12-12T03:42:35.817Z","repository":{"id":30437358,"uuid":"33990439","full_name":"remarkjs/remark-comment-config","owner":"remarkjs","description":"plugin to configure remark with comments","archived":false,"fork":false,"pushed_at":"2023-09-22T12:09:16.000Z","size":138,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-12-05T13:58:22.697Z","etag":null,"topics":["comment","markdown","remark","remark-plugin"],"latest_commit_sha":null,"homepage":"https://remark.js.org","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/remarkjs.png","metadata":{"funding":{"github":"unifiedjs","open_collective":"unified"},"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-04-15T11:41:55.000Z","updated_at":"2025-03-04T07:09:03.000Z","dependencies_parsed_at":"2022-08-31T03:01:29.487Z","dependency_job_id":null,"html_url":"https://github.com/remarkjs/remark-comment-config","commit_stats":{"total_commits":142,"total_committers":2,"mean_commits":71.0,"dds":"0.021126760563380254","last_synced_commit":"7702540310b9303472fe5c16848340e76c7e529a"},"previous_names":["wooorm/mdast-comment-config"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/remarkjs/remark-comment-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-comment-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-comment-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-comment-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-comment-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remarkjs","download_url":"https://codeload.github.com/remarkjs/remark-comment-config/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-comment-config/sbom","scorecard":{"id":770055,"data":{"date":"2025-08-11","repo":{"name":"github.com/remarkjs/remark-comment-config","commit":"9aaadcfd173f5d1129ceba2690db4b00b4c4d928"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"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":"Code-Review","score":0,"reason":"Found 1/30 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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/remarkjs/remark-comment-config/bb.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/remarkjs/remark-comment-config/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/remarkjs/remark-comment-config/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/remarkjs/remark-comment-config/main.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/main.yml:15","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/bb.yml:1","Warn: no topLevel permission defined: .github/workflows/main.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/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":"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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":10,"reason":"license file detected","details":["Info: project has a license file: license:0","Info: FSF or OSI recognized license: MIT License: license:0"],"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":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 6.0.0 not signed: https://api.github.com/repos/remarkjs/remark-comment-config/releases/32140063","Warn: release artifact 5.1.1 not signed: https://api.github.com/repos/remarkjs/remark-comment-config/releases/24751024","Warn: release artifact 6.0.0 does not have provenance: https://api.github.com/repos/remarkjs/remark-comment-config/releases/32140063","Warn: release artifact 5.1.1 does not have provenance: https://api.github.com/repos/remarkjs/remark-comment-config/releases/24751024"],"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 'main'"],"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":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/remarkjs/.github/security.md:1","Info: Found linked content: github.com/remarkjs/.github/security.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/remarkjs/.github/security.md:1","Info: Found text in security policy: github.com/remarkjs/.github/security.md:1"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T01:58:22.652Z","repository_id":30437358,"created_at":"2025-08-23T01:58:22.652Z","updated_at":"2025-08-23T01:58:22.652Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27528028,"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-12-05T02:00:07.920Z","response_time":54,"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":["comment","markdown","remark","remark-plugin"],"created_at":"2025-06-10T21:19:06.781Z","updated_at":"2025-12-12T03:42:35.796Z","avatar_url":"https://github.com/remarkjs.png","language":"JavaScript","readme":"# remark-comment-config\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n**[remark][]** plugin to configure it with comments.\n\n## Contents\n\n*   [What is this?](#what-is-this)\n*   [When should I use this?](#when-should-i-use-this)\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`unified().use(remarkCommentConfig)`](#unifieduseremarkcommentconfig)\n*   [Types](#types)\n*   [Compatibility](#compatibility)\n*   [Security](#security)\n*   [Related](#related)\n*   [Contribute](#contribute)\n*   [License](#license)\n\n## What is this?\n\nThis package is a [unified][] ([remark][]) plugin to configure remark\n(specifically, how `remark-stringify` formats markdown) from comments.\n\n## When should I use this?\n\nThis project is useful when you want to change how markdown is formatted,\nrepeatedly, from within a file.\nYou can use this when you trust authors and want to give them control.\n\nThis plugin is very similar to the alternative\n[`remark-yaml-config`][remark-yaml-config].\nThe difference is that that plugin uses YAML frontmatter, which comes at the\nstart of documents, whereas this plugin uses comments, which can come anywhere\nin the document.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16+), install with [npm][]:\n\n```sh\nnpm install remark-comment-config\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport remarkCommentConfig from 'https://esm.sh/remark-comment-config@8'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import remarkCommentConfig from 'https://esm.sh/remark-comment-config@8?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\nSay we have the following file `example.md`:\n\n```markdown\n# Moons of Neptune\n\n\u003c!--remark bullet=\"+\"--\u003e\n\n- Naiad\n\n\u003c!--remark bullet=\"-\"--\u003e\n\n- Thalassa\n\n\u003c!--remark bullet=\"*\"--\u003e\n\n- Despina\n```\n\n…and a module `example.js`:\n\n```js\nimport {remark} from 'remark'\nimport remarkCommentConfig from 'remark-comment-config'\nimport {read} from 'to-vfile'\n\nconst file = await remark()\n  .use(remarkCommentConfig)\n  .process(await read('example.md'))\n\nconsole.log(String(file))\n```\n\n…then running `node example.js` yields:\n\n```markdown\n# Moons of Neptune\n\n\u003c!--remark bullet=\"+\"--\u003e\n\n+ Naiad\n\n\u003c!--remark bullet=\"-\"--\u003e\n\n- Thalassa\n\n\u003c!--remark bullet=\"*\"--\u003e\n\n* Despina\n```\n\n## API\n\nThis package exports no identifiers.\nThe default export is [`remarkCommentConfig`][api-remark-comment-config].\n\n### `unified().use(remarkCommentConfig)`\n\nConfigure remark with comments.\n\nComments should start with `remark` and contain “attributes” for settings.\nFor example, `\u003c!--remark foo=\"bar\" baz--\u003e`.\nThe settings are passed to [`remark-stringify`][remark-stringify-options].\n\n###### Parameters\n\nThere are no parameters.\n\n###### Returns\n\nNothing (`undefined`).\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports no additional types.\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `remark-comment-config@^8`,\ncompatible with Node.js 16.\n\nThis plugin works with `remark` version 13+.\nVersion 5 (and lower) worked with older versions of remark.\n\n## Security\n\nUse of `remark-comment-config` can change how markdown is compiled.\nIf the markdown is user provided, this may open you up to a\n[cross-site scripting (XSS)][wiki-xss] attack.\n\n## Related\n\n*   [`remark-yaml-config`][remark-yaml-config]\n    — configure remark with YAML\n*   [`remark-message-control`][remark-message-control]\n    — configure messages with comments\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/remarkjs/remark-comment-config/workflows/main/badge.svg\n\n[build]: https://github.com/remarkjs/remark-comment-config/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-comment-config.svg\n\n[coverage]: https://codecov.io/github/remarkjs/remark-comment-config\n\n[downloads-badge]: https://img.shields.io/npm/dm/remark-comment-config.svg\n\n[downloads]: https://www.npmjs.com/package/remark-comment-config\n\n[size-badge]: https://img.shields.io/bundlejs/size/remark-comment-config\n\n[size]: https://bundlejs.com/?q=remark-comment-config\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/remarkjs/remark/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[health]: https://github.com/remarkjs/.github\n\n[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md\n\n[support]: https://github.com/remarkjs/.github/blob/main/support.md\n\n[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[remark]: https://github.com/remarkjs/remark\n\n[remark-message-control]: https://github.com/remarkjs/remark-message-control\n\n[remark-stringify-options]: https://github.com/remarkjs/remark/blob/main/packages/remark-stringify/readme.md#options\n\n[remark-yaml-config]: https://github.com/remarkjs/remark-yaml-config\n\n[typescript]: https://www.typescriptlang.org\n\n[unified]: https://github.com/unifiedjs/unified\n\n[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting\n\n[api-remark-comment-config]: #unifieduseremarkcommentconfig\n","funding_links":["https://github.com/sponsors/unifiedjs","https://opencollective.com/unified"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkjs%2Fremark-comment-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremarkjs%2Fremark-comment-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkjs%2Fremark-comment-config/lists"}