{"id":18464336,"url":"https://github.com/projectdiscovery/js-proto-docs","last_synced_at":"2026-03-19T04:33:16.888Z","repository":{"id":195178222,"uuid":"692131083","full_name":"projectdiscovery/js-proto-docs","owner":"projectdiscovery","description":"API Reference for Javascript protocol","archived":false,"fork":false,"pushed_at":"2023-09-20T16:11:32.000Z","size":415,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-11T10:25:25.183Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://projectdiscovery.github.io/js-proto-docs/","language":null,"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/projectdiscovery.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,"zenodo":null}},"created_at":"2023-09-15T16:18:46.000Z","updated_at":"2025-12-18T11:54:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"63d8447c-53b5-4334-ab37-8c325a13802c","html_url":"https://github.com/projectdiscovery/js-proto-docs","commit_stats":null,"previous_names":["projectdiscovery/js-proto-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/projectdiscovery/js-proto-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectdiscovery%2Fjs-proto-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectdiscovery%2Fjs-proto-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectdiscovery%2Fjs-proto-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectdiscovery%2Fjs-proto-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/projectdiscovery","download_url":"https://codeload.github.com/projectdiscovery/js-proto-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectdiscovery%2Fjs-proto-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29391145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T00:53:09.511Z","status":"ssl_error","status_checked_at":"2026-02-13T00:53:09.126Z","response_time":55,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":[],"created_at":"2024-11-06T09:09:29.356Z","updated_at":"2026-02-13T01:10:20.594Z","avatar_url":"https://github.com/projectdiscovery.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# js-proto-docs\n\nAutogenerated Javascript documention of all modules/functions etc available in Nuclei Javascript Protocol\n\n## Generate/Update HTML Docs\n\n### Install `clean-jsdoc-theme`\n\nrefer [docs](https://www.npmjs.com/package/clean-jsdoc-theme) for more details or install using below command\n\n```console\n$ npm install -g clean-jsdoc-theme\n```\n\n### Install `jsdoc`\n\nrefer [docs](https://www.npmjs.com/package/jsdoc) for more details or install using below command\n\n```console\n$ npm install -g jsdoc\n```\n\n### Locate `clean-jsdoc-theme` directory\n\nIts usually located at `$(npm root -g)/clean-jsdoc-theme` when installed globally\n\n### Clone target nuclei repo and navigate to desired branch\n\n```console\n$ gh repo clone projectdiscovery/nuclei\n```\n\n### Generate docs\n\n```console\n$ jsdoc -R nuclei/docs/template-guide/javascript.mdx -r -d docs/ -t $(npm root -g)/clean-jsdoc-theme nuclei/v2/pkg/js/generated/js\n```\n\n\u003e If above command fails, try updating paths \n\u003e Here's expected command\n\u003e \n\u003e  jsdoc -R [Homepage.md] -r -d api_reference -t [optional: jsdoc theme to use] generated/js\n\n\n### Verify generated docs\n\n```console\n$ cd docs \u0026\u0026 simplehttpserver\n```\n\n\n### Contributing\n\nIf you want to update / fix something in docs etc . Please update docs present at https://github.com/projectdiscovery/nuclei/tree/main/v2/pkg/js/generated/js and then follow above steps to generate docs and create a PR with updated docs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectdiscovery%2Fjs-proto-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectdiscovery%2Fjs-proto-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectdiscovery%2Fjs-proto-docs/lists"}