{"id":34260158,"url":"https://github.com/hegemonic/jsdoc-baseline","last_synced_at":"2025-12-16T15:52:28.024Z","repository":{"id":12809013,"uuid":"15483927","full_name":"hegemonic/jsdoc-baseline","owner":"hegemonic","description":"An experimental, extensible template for JSDoc.","archived":false,"fork":false,"pushed_at":"2025-12-11T04:51:08.000Z","size":5118,"stargazers_count":61,"open_issues_count":53,"forks_count":31,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-11T08:23:33.825Z","etag":null,"topics":["api","baseline","docs","documentation","javascript","jsdoc","template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hegemonic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-12-27T23:39:57.000Z","updated_at":"2025-12-10T21:01:39.000Z","dependencies_parsed_at":"2024-01-05T00:25:57.660Z","dependency_job_id":"e42f66e3-7c23-4647-a436-3881f48db1b7","html_url":"https://github.com/hegemonic/jsdoc-baseline","commit_stats":{"total_commits":828,"total_committers":10,"mean_commits":82.8,"dds":"0.47101449275362317","last_synced_commit":"41078da67efe175d3d254830c5f35878916080d7"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/hegemonic/jsdoc-baseline","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hegemonic%2Fjsdoc-baseline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hegemonic%2Fjsdoc-baseline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hegemonic%2Fjsdoc-baseline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hegemonic%2Fjsdoc-baseline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hegemonic","download_url":"https://codeload.github.com/hegemonic/jsdoc-baseline/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hegemonic%2Fjsdoc-baseline/sbom","scorecard":{"id":459636,"data":{"date":"2025-08-11","repo":{"name":"github.com/hegemonic/jsdoc-baseline","commit":"a79f929a5d1a1c6769b065e8d5634b4e54826e59"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.3,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","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":"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":"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":"Code-Review","score":0,"reason":"Found 0/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":"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":"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":"Token-Permissions","score":10,"reason":"GitHub workflow tokens follow principle of least privilege","details":["Info: found token with 'none' permissions: .github/workflows/build.yaml: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":"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/build.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/hegemonic/jsdoc-baseline/build.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/hegemonic/jsdoc-baseline/build.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/hegemonic/jsdoc-baseline/build.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/hegemonic/jsdoc-baseline/build.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/hegemonic/jsdoc-baseline/build.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/hegemonic/jsdoc-baseline/build.yaml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/build.yaml:71","Warn: npmCommand not pinned by hash: .github/workflows/build.yaml:37","Warn: npmCommand not pinned by hash: .github/workflows/build.yaml:54","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 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":"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":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/f6ed084d17c9236477efd66e5b258b9d4cc7b389/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/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":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"}}]},"last_synced_at":"2025-08-19T10:45:08.013Z","repository_id":12809013,"created_at":"2025-08-19T10:45:08.013Z","updated_at":"2025-08-19T10:45:08.013Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27767368,"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-16T02:00:10.477Z","response_time":57,"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":["api","baseline","docs","documentation","javascript","jsdoc","template"],"created_at":"2025-12-16T15:52:27.247Z","updated_at":"2025-12-16T15:52:28.019Z","avatar_url":"https://github.com/hegemonic.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Baseline\n\n![Build status](https://img.shields.io/github/actions/workflow/status/hegemonic/jsdoc-baseline/build.yaml?branch=main\u0026style=flat-square)\n[![npm version](https://img.shields.io/npm/v/jsdoc-baseline.svg?style=flat-square)](https://www.npmjs.org/package/jsdoc-baseline)\n\nAn extensible template for [JSDoc][jsdoc].\n\n**This is a preview version of the Baseline template.** Baseline is under active development.\nEverything in the template is subject to change.\n\n## What is Baseline?\n\nBaseline is an HTML template for [JSDoc][jsdoc]. It offers several benefits:\n\n- **Extensible from the ground up.** You can use extensions to customize your documentation's\n  content and appearance without changing Baseline itself. In addition, you can localize the\n  headings and other text that are added by the template. **Note:** Customization options are\n  limited in this preview version.\n- **Easy to navigate.** An expandable table of contents helps users find what they're looking for.\n  Also, a summary at the top of each page shows what's documented on that page.\n- **Modern template syntax.** Baseline uses [Nunjucks][nunjucks], a powerful JavaScript template\n  engine, to define the template layout. You can define new Nunjucks filters and use them in your\n  customizations to Baseline.\n\n## Installing Baseline\n\n1.  Add [JSDoc][jsdoc] to your Node.js project as a development dependency:\n\n    ```sh\n    npm install --save-dev jsdoc\n    ```\n\n2.  Add the Baseline template to your Node.js project as a development dependency:\n\n    ```sh\n    npm install --save-dev jsdoc-baseline\n    ```\n\n## Configuring and using Baseline\n\nTo use the Baseline template with its default settings, run JSDoc with the `--template` (or `-t`)\ncommand-line option:\n\n```sh\njsdoc --template \u003cpath/to/baseline\u003e \u003cpath/to/js-files\u003e\n```\n\nTo use the Baseline template with customized settings:\n\n1.  Copy `baseline-config-example.json` to a new file (for example, `baseline-config.json`).\n2.  Modify the configuration file as needed. See `baseline-config-example.json` for information\n    about the supported options. You can use comments in the configuration file.\n3.  Update your JSDoc `conf.json` file to include a `templates.baseline` property. This property\n    must contain the path to your Baseline configuration file.\n4.  Run JSDoc as shown above, using the `--configure` (or `-c`) option to tell JSDoc where to find\n    your `conf.json` file:\n\n```sh\njsdoc --configure \u003cpath/to/conf.json\u003e --template \u003cpath/to/baseline\u003e \u003cpath/to/js-files\u003e\n```\n\n## Legal stuff\n\nCopyright 2014 the Baseline Authors. Licensed under the Apache License, Version 2.0. See\n[LICENSE.md][license] for more information.\n\n[jsdoc]: https://github.com/jsdoc/jsdoc\n[license]: https://github.com/hegemonic/jsdoc-baseline/blob/master/LICENSE.md\n[nunjucks]: https://mozilla.github.io/nunjucks/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhegemonic%2Fjsdoc-baseline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhegemonic%2Fjsdoc-baseline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhegemonic%2Fjsdoc-baseline/lists"}