Skip to content

projectdiscovery/docs

Repository files navigation

ProjectDiscovery Documentation

This is the source code for the ProjectDiscovery documentation located at https://docs.projectdiscovery.io

DevelopmentDeployingJoin Discord


Development

  1. Checkout this repository
  2. Install mintlify with npm i -g mintlify@latest
  3. Run mintlify dev

Deploying

To build the final product, we have a couple of additional steps:

  1. Build the JS Protocol Docs
  • npm install -g jsdoc-to-markdown
  • ./bin/jsdocs.sh
  1. Build the PDCP API reference documentation
  • Either download the latest openapi.yaml manually or run ./bin/download-api.sh
  • Run ./bin/generate-api.sh to generate any new API files
  1. Deployment

After those, Mintlify handles the deployment automatically.