{"id":30860674,"url":"https://github.com/benchmark-urbanism/remark-bibtex","last_synced_at":"2025-09-07T16:14:26.144Z","repository":{"id":105087769,"uuid":"358542343","full_name":"benchmark-urbanism/remark-bibtex","owner":"benchmark-urbanism","description":"Remark-bibtex is a remark plugin to generate footnoted citations from a bibtex file.","archived":false,"fork":false,"pushed_at":"2023-01-02T20:21:31.000Z","size":137,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-12T15:41:10.841Z","etag":null,"topics":["citation-keys","citations","footnotes","markdown","markdown-parser","remark","static-site-generator"],"latest_commit_sha":null,"homepage":"https://github.com/benchmark-urbanism/remark-bibtex","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/benchmark-urbanism.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-16T09:15:06.000Z","updated_at":"2023-03-17T00:01:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"87866640-61d5-4632-bf9f-a4de8c14311a","html_url":"https://github.com/benchmark-urbanism/remark-bibtex","commit_stats":{"total_commits":16,"total_committers":1,"mean_commits":16.0,"dds":0.0,"last_synced_commit":"c0d4b4eb286a89de7f0a885bfd1e3da5a6942896"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/benchmark-urbanism/remark-bibtex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchmark-urbanism%2Fremark-bibtex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchmark-urbanism%2Fremark-bibtex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchmark-urbanism%2Fremark-bibtex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchmark-urbanism%2Fremark-bibtex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benchmark-urbanism","download_url":"https://codeload.github.com/benchmark-urbanism/remark-bibtex/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benchmark-urbanism%2Fremark-bibtex/sbom","scorecard":{"id":231688,"data":{"date":"2025-08-11","repo":{"name":"github.com/benchmark-urbanism/remark-bibtex","commit":"c0d4b4eb286a89de7f0a885bfd1e3da5a6942896"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/16 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":"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":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":"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":"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/ci.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/benchmark-urbanism/remark-bibtex/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/benchmark-urbanism/remark-bibtex/ci.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction 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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.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":"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":"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":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":-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 '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":"Vulnerabilities","score":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"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-17T04:58:04.452Z","repository_id":105087769,"created_at":"2025-08-17T04:58:04.452Z","updated_at":"2025-08-17T04:58:04.452Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274059990,"owners_count":25215408,"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-09-07T02:00:09.463Z","response_time":67,"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":["citation-keys","citations","footnotes","markdown","markdown-parser","remark","static-site-generator"],"created_at":"2025-09-07T16:14:22.384Z","updated_at":"2025-09-07T16:14:26.138Z","avatar_url":"https://github.com/benchmark-urbanism.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e Please note that this package is deprecated. Please consider using [rehype-citation](https://github.com/timlrx/rehype-citation) instead.\n\n# remark-bibtex\n\nRemark-bibtex is a [remark](https://github.com/wooorm/remark) plugin to generate footnoted citations from a `bibtex` file. It uses [`citation-js`](https://github.com/citation-js/citation-js) to load a specified `.bib` file from which citations will be retrieved and added to the markdown file's footnotes section.\n\nCitation keys take the form of `(@citationKey)`: where \"citationKey\" corresponds to a bibtex entry in the provided `.bib` file. The citation key will be replaced with a numbered footnote reference corresponding to the bibliography entry in the footnotes section.\n\nIn order to work, this package has to be chained to the [`remark-gfm`](https://github.com/remarkjs/remark-gfm) package, which adds the necessary markdown footnoting capability.\n\n```md\n# My Document\n\nSo here is my citation (@Wasserman1994). End of story.\n```\n\nWill become:\n\n```md\nSo here is my citation[^1]. End of story.\n\n[^1]: 1\\. Wasserman S, Faust K. Social Network Analysis. Cambridge: Cambridge University Press; 1994.\n```\n\n## Install\n\n```sh\nyarn add remark-gfm @benchmark-urbanism/remark-bibtex\n```\n\n## Usage\n\n```js\nimport { remark } from 'remark'\nimport remarkGfm from 'remark-gfm'\nimport remarkBibtex from '../index.js'\n\nconst bibtexFilePath = './example/example.bib'\n\nremark()\n  .use(remarkGfm)\n  .use(remarkBibtex, { bibtexFile: bibtexFilePath })\n  .process('Ref A: (@Harris2020) Ref B: (@Wasserman1994)')\n  .then((content) =\u003e content.toString())\n  .then((markdown) =\u003e console.log(markdown))\n  .catch((err) =\u003e console.error(err))\n\n```\n\nWill give:\n\n```md\nRef A:[^1] Ref B:[^2]\n\n[^1]: 1\\. Harris CR, Millman KJ, van der Walt SJ, Gommers R, Virtanen P, Cournapeau D, et al. Array programming with NumPy. Nature \\[Internet]. 2020 Sep;585(7825):357–62. Available from: http\\://www\\.nature.com/articles/s41586-020-2649-2\n\n\n[^2]: 1\\. Wasserman S, Faust K. Social Network Analysis. Cambridge: Cambridge University Press; 1994.\u0026#x20;\n```\n\n### Options\n\n### options.bibtexFile\n\nA mandatory filepath to the `.bib` file to be loaded by `citation-js`\n\n## License\n\nMIT © Gareth Simons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenchmark-urbanism%2Fremark-bibtex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenchmark-urbanism%2Fremark-bibtex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenchmark-urbanism%2Fremark-bibtex/lists"}