{"id":20645551,"url":"https://github.com/helpfulscripts/hsdocs","last_synced_at":"2026-04-17T16:02:56.634Z","repository":{"id":32590334,"uuid":"137648137","full_name":"HelpfulScripts/hsDocs","owner":"HelpfulScripts","description":"an API documentation viewer for typescript projects based on typedoc. See: ","archived":false,"fork":false,"pushed_at":"2022-02-16T16:49:07.000Z","size":54862,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-24T16:27:12.150Z","etag":null,"topics":["api","docs","docset","documentation","hsdocs","typedoc","typescript"],"latest_commit_sha":null,"homepage":"https://helpfulscripts.github.io/hsDocs/#!/api/hsDocs/0","language":"TypeScript","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/HelpfulScripts.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}},"created_at":"2018-06-17T10:55:24.000Z","updated_at":"2020-12-31T22:28:24.000Z","dependencies_parsed_at":"2022-08-07T17:45:44.475Z","dependency_job_id":null,"html_url":"https://github.com/HelpfulScripts/hsDocs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/HelpfulScripts/hsDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HelpfulScripts","download_url":"https://codeload.github.com/HelpfulScripts/hsDocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsDocs/sbom","scorecard":{"id":62020,"data":{"date":"2025-08-11","repo":{"name":"github.com/HelpfulScripts/hsDocs","commit":"fbb4179015725e40fa9221db04d8b129505ed1a7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.6,"checks":[{"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":"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":"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/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":"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":"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":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/HelpfulScripts/hsDocs/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/HelpfulScripts/hsDocs/main.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/main.yml:28","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   1 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/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":"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":"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 '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":"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"}}]},"last_synced_at":"2025-08-15T01:55:13.549Z","repository_id":32590334,"created_at":"2025-08-15T01:55:13.549Z","updated_at":"2025-08-15T01:55:13.549Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31935697,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T12:37:54.787Z","status":"ssl_error","status_checked_at":"2026-04-17T12:37:25.095Z","response_time":62,"last_error":"SSL_read: 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","docs","docset","documentation","hsdocs","typedoc","typescript"],"created_at":"2024-11-16T16:20:20.544Z","updated_at":"2026-04-17T16:02:56.604Z","avatar_url":"https://github.com/HelpfulScripts.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"hsDocs \n========\n[![NPM License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://www.npmjs.com/package/hsdocs)\n[![npm version](https://badge.fury.io/js/hsdocs.svg)](https://badge.fury.io/js/hsdocs)\n[![docs](https://img.shields.io/badge/hsDocs-hsDocs-blue.svg)](https://helpfulscripts.github.io/hsDocs/#!/api/hsDocs/0)\n[![Build Status](https://github.com/HelpfulScripts/hsDocs/workflows/CI/badge.svg)](https://github.com/HelpfulScripts/hsDocs/) \n[![codecov](https://codecov.io/gh/HelpfulScripts/hsDocs/branch/master/graph/badge.svg)](https://codecov.io/gh/HelpfulScripts/hsDocs)\n[![Known Vulnerabilities](https://snyk.io/test/github/HelpfulScripts/hsDocs/badge.svg?targetFile=package.json)](https://snyk.io/test/github/HelpfulScripts/hsDocs?targetFile=package.json)\n[![Dependencies Status](https://david-dm.org/helpfulscripts/hsdocs.svg)](https://david-dm.org/helpfulscripts/hsdocs)\n\nHelpful Scripts code documentation tool.\n\n**hsDocs**  is an alternative code documentation viewer for [Typescript](https://www.typescriptlang.org) projects.\nIt renders JSON documentation files, as created by [typedoc](http://typedoc.org), into html pages that can be viewed via browser. [This example](https://helpfulscripts.github.io/hsDocs/#!/api/hsDocs/0) shows the rendered docset for the hsDoc code itself.\n\n## Features\nProvides a more compact overview of `Typescript` library documentation as an alternative to `Typedoc` ...\n- facilitating live, interactive code examples in the docs to illustrate functionality and usage\n- allowing display of multiple libraries via tabs\n\n\n## Usage\n1 - Create a web-app directory to serve the docsets from. As an example, \nsee the [`docs` folder](https://github.com/HelpfulScripts/hsDocs/tree/master/docs) in this project's Github page, which serves the [Github IO pages for this project](https://helpfulscripts.github.io/hsDocs/#!/api/hsDocs/0)\n\n2a - Copy the [`index.html` file](https://github.com/HelpfulScripts/hsDocs/tree/master/docs/index.html) from Github into the new directory, \nor create a new **`index.html`** as follows. This will use the `GitHub`-hosted version of `hsDocs`:\n```\n\u003chtml\u003e\n   \u003chead\u003e\n      \u003clink href=\"https://helpfulscripts.github.io/hsDocs/hsDocs.css\" rel=\"stylesheet\" /\u003e\n   \u003c/head\u003e\n   \u003cbody class='hs-layout-fill'\u003e\n      \u003cscript src=\"https://helpfulscripts.github.io/hsDocs/hsDocs.min.js\"\u003e\u003c/script\u003e\n    \u003c/body\u003e\n\u003c/html\u003e\n```\n\n2b - Alternatively you can use a self-hosted hsDocs version. Copy the `hsDocs` runtimes \n(`hsDocs.js`, `hsDocs.min.js`, `hsDocs.css`, `hsDocs.css.map`) from\n[Github](https://github.com/HelpfulScripts/hsDocs/tree/master/docs) into the directory and modify `index.html` as follows:\n```\n\u003chtml\u003e\n   \u003chead\u003e\u003clink href=\"hsDocs.css\" rel=\"stylesheet\" /\u003e\u003c/head\u003e\n   \u003cbody class='hs-layout-fill'\u003e\n      \u003cscript src=\"./hsDocs.min.js\"\u003e\u003c/script\u003e\n   \u003c/body\u003e\n\u003c/html\u003e\n```\n\n3 - Install `typedoc` and, inside your project folder, run\n```\ntypedoc --json docs.json src\n(or: ./node_modules/.bin/typedoc --json docs.json src)\n```\nin your project folder. This assumes `src` is the path to the sources the sources. \nCreate a subdirectory **`./data`** and copy the docset into it - i.e. `docs.json` if you used the \ncommend above.\n\nSee below for more details on creating the docset.\n\n4 - Create a list of docsets to render in a new file **`index.json`** inside **`./data`**.\nFiles in the `docs` array are interpreted relative to the `./data` folder unless they are full URLs.\n```\n{   \"docs\": [\n        \"docs.json\",\n        \"http://helpfulscripts.github.io/hsLayout/data/hsLayout.json\",\n        ...\n    ],\n    \"title\": \"HS Libraries\"   // will be displayed at the top left corner\n}\n```\n\n5 - optionally, create a `src` folder inside the `data` folder and copy the `html`-ified source files into it. \nThese are created by the command `grunt sourceCode` in the `docs/data/src/` folder of your project.\n\n6 - Point a browser to the web-app directory\n\n\n## Creating the Documentation DocSet\nFollow the instruction for [`typedoc`](https://typedoc.org/guides/doccomments/) in commenting the code \nand set the [`json`](https://typedoc.org/guides/options/#json) option to create a \njson file containing the documentation. See the Configuration section below for details.\n\nIn addition to the documented source files, `hsDocs` recognizes a special **`overview.ts`** file \nthat will be displayed as a project overview. \nFor this to work, `typedoc` requires the file to have two separate comment entries.\nIf the second comment is missing, `typedoc` will not generate a comment in the DocSet.\n\nDocSets are shown as menu tabs across the top of the window. To include a DocSet in the menu, ensure that the \ncorresponding documentation `.json` file is copied into the `data` folder inside the `hsDocs` staging location \nfor the http server. Then edit the `index.json` file to include the documentation file name in the \"docs\" section. \nSee [hsDocs/docs/data](https://github.com/HelpfulScripts/hsDocs/tree/master/docs/data) fro an example.\n\n## Installation\nInstall `hsDocs` from `npm` the standard way:\n\u003e `npm i hsdocs`\n\n## Typedoc configuration\nBelow is an example configuration for use with `grunt` and [`grunt-typedoc`](https://www.npmjs.com/package/grunt-typedoc): \n```\ntypedoc: {\n    code: {\n        options: {\n            target: 'es6',\n            module: 'commonjs',\n            moduleResolution: \"node\",\n            json:   `docs/data/myLib.json`,\n            mode:   'modules',\n            name:   `myLib`\n        },\n        src: ['src/**/*.ts', '!src/**/*.*.ts'] // all .ts files, no specs\n    }\n}\n```\n\nPlease see the [docs](https://helpfulscripts.github.io/hsDocs/#!/api/hsDocs/0) for further documentation and examples\n\nPlease report any issues and provide feedback.\n ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpfulscripts%2Fhsdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelpfulscripts%2Fhsdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpfulscripts%2Fhsdocs/lists"}