https://github.com/projectdiscovery/docs

Centralized docs of ProjectDiscovery
https://github.com/projectdiscovery/docs

docs

Last synced: over 1 year ago
JSON representation

Centralized docs of ProjectDiscovery

• Host: GitHub
• URL: https://github.com/projectdiscovery/docs
• Owner: projectdiscovery
• Created: 2023-10-12T15:47:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-06T18:21:14.000Z (about 2 years ago)
• Last Synced: 2024-06-07T22:01:35.185Z (about 2 years ago)
• Topics: docs
• Language: MDX
• Homepage: https://docs.projectdiscovery.io
• Size: 12.5 MB
• Stars: 3
• Watchers: 10
• Forks: 26
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ProjectDiscovery Documentation



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















  Development •

  Deploying •

  Join Discord



---

## Development

1. Checkout this repository

1. Install mintlify with `npm i -g mintlify@latest`

1. 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`

2. 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

3. Deployment

After those, Mintlify handles the deployment automatically.