https://github.com/projectdiscovery/js-proto-docs
API Reference for Javascript protocol
https://github.com/projectdiscovery/js-proto-docs
Last synced: 4 months ago
JSON representation
API Reference for Javascript protocol
- Host: GitHub
- URL: https://github.com/projectdiscovery/js-proto-docs
- Owner: projectdiscovery
- License: mit
- Created: 2023-09-15T16:18:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-20T16:11:32.000Z (almost 3 years ago)
- Last Synced: 2026-02-11T10:25:25.183Z (5 months ago)
- Homepage: https://projectdiscovery.github.io/js-proto-docs/
- Size: 405 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# js-proto-docs
Autogenerated Javascript documention of all modules/functions etc available in Nuclei Javascript Protocol
## Generate/Update HTML Docs
### Install `clean-jsdoc-theme`
refer [docs](https://www.npmjs.com/package/clean-jsdoc-theme) for more details or install using below command
```console
$ npm install -g clean-jsdoc-theme
```
### Install `jsdoc`
refer [docs](https://www.npmjs.com/package/jsdoc) for more details or install using below command
```console
$ npm install -g jsdoc
```
### Locate `clean-jsdoc-theme` directory
Its usually located at `$(npm root -g)/clean-jsdoc-theme` when installed globally
### Clone target nuclei repo and navigate to desired branch
```console
$ gh repo clone projectdiscovery/nuclei
```
### Generate docs
```console
$ jsdoc -R nuclei/docs/template-guide/javascript.mdx -r -d docs/ -t $(npm root -g)/clean-jsdoc-theme nuclei/v2/pkg/js/generated/js
```
> If above command fails, try updating paths
> Here's expected command
>
> jsdoc -R [Homepage.md] -r -d api_reference -t [optional: jsdoc theme to use] generated/js
### Verify generated docs
```console
$ cd docs && simplehttpserver
```
### Contributing
If 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.