mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-24 13:45:25 +00:00
dc44105baf
* use parsed options while signing * update project layout to v3 * fix .gitignore * remove example template * misc updates * bump tlsx version * hide template sig warning with env * js: retain value while using log * fix nil pointer derefernce * misc doc update --------- Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
## devtools
|
|
|
|
devtools contains tools and scripts to automate booring tasks related to javascript layer/ packages.
|
|
|
|
### bindgen
|
|
|
|
[bindgen](./bindgen/README.md) is a tool that automatically generated bindings for native go packages with 'goja'
|
|
|
|
### jsdocgen
|
|
|
|
[jsdocgen](./jsdocgen/README.md) is LLM (OpenAI) based dev tool it takes generated javascript files and annotes them with jsdoc comments using predefined prompt
|
|
|
|
### scrapefuncs
|
|
|
|
[scrapefuncs](./scrapefuncs/README.md) is a tool to scrapes all helper functions exposed in javascript with help of go/ast and generates a js file with jsdoc comments using LLM (OpenAI)
|
|
|
|
|
|
### Generating API Reference (aka static site using javascript files using jsdoc)
|
|
|
|
```console
|
|
jsdoc -R [Homepage.md] -r -d api_reference -t [optional: jsdoc theme to use] generated/js
|
|
```
|
|
|
|
generated static site will be available at `api_reference/` directory and can be verified using simplehttpserver
|
|
|
|
```console
|
|
simplehttpserver
|
|
```
|
|
|
|
and then open `http://localhost:8000/` in browser
|
|
|
|
|
|
### Notes
|
|
|
|
we currently use [clean-jsdoc-theme](https://www.npmjs.com/package/clean-jsdoc-theme) demo at [sample-jsproto-docs/](https://projectdiscovery.github.io/js-proto-docs/) |