generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: enhance docs with icons, frames, fix broken image and improved …
…image SEO (#71) * feat: enhance docs with icons, frames, fix broken image and improved image SEO * links update --------- Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
- Loading branch information
Showing
11 changed files
with
131 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,77 @@ | ||
--- | ||
title: 'Start Here' | ||
description: 'New to ProjectDiscovery and looking to get started?' | ||
sidebarTitle: 'Start Here!' | ||
title: 'Get Started with ProjectDiscovery' | ||
sidebarTitle: 'Quickstart' | ||
"icon": "rocket" | ||
--- | ||
|
||
## Overview | ||
|
||
Welcome to Getting Started! This section is designed to help you quickly install, set up, and scan using just a few parts of ProjectDiscovery’s suite of open-source tools. | ||
This section will guide you through the quickest way to install, set up, and run a scan using some key ProjectDiscovery open-source tools. | ||
|
||
The steps here are simple to get you insightful results with the quickest path possible. | ||
Because ProjectDiscovery has so many tools we're going to focus on a few to demonstrate some of our core product capabilities. | ||
We’ll focus on a few tools to demonstrate ProjectDiscovery’s core capabilities. If you want to explore more tools and features, don’t hesitate to [reach out](/help). | ||
|
||
We do have a ton of other open-source tools that can enhance, expand, or adapt for your particular use cases. | ||
So if at the end of this process you still have questions - [reach out](/help). | ||
|
||
<Tip> If you're looking to learn more about _ProjectDiscovery Cloud Platform (PDCP)_, head over to [PDCP Introduction](/cloud/introduction) for details on our platform. </Tip> | ||
<Tip> Interested in learning more about the **ProjectDiscovery Cloud Platform (PDCP)**? Visit the [PDCP Introduction](/cloud/introduction) for all the details. </Tip> | ||
|
||
## What's in Getting Started? | ||
The getting started journey steps are: | ||
- Installing the latest version of Go | ||
- Installing Nuclei | ||
- Running a scan | ||
- Reviewing your results | ||
|
||
## Check out the example | ||
Get started with ProjectDiscovery in a few simple steps: | ||
|
||
- Installing the latest version of Go | ||
- Installing Nuclei | ||
- Running a scan | ||
- Reviewing your results | ||
|
||
|
||
<Steps> | ||
<Step title="Step 1: Installing the Latest Version of Go"> | ||
Download and install the latest version of Go from the official website. Ensure that your system is up to date and Go is properly installed by running `go version` in your terminal. | ||
</Step> | ||
<Step title="Step 2: Installing Nuclei"> | ||
Install Nuclei by following the instructions in the official [Nuclei documentation](https://docs.projectdiscovery.io/tools/nuclei/install/). You can use package managers or build from source. | ||
</Step> | ||
<Step title="Step 3: Running a Scan"> | ||
After installing Nuclei, run your first scan with the command: | ||
```bash | ||
nuclei -u https://your-target-domain.com | ||
``` | ||
This will initiate a scan on the target domain. | ||
</Step> | ||
<Step title="Step 4: Reviewing Your Results"> | ||
Once the scan is complete, review the results to identify any potential vulnerabilities. Nuclei will generate a report of findings that you can act on. | ||
</Step> | ||
</Steps> | ||
|
||
|
||
<Tip> | ||
**Next Steps** | ||
|
||
Follow the links below to explore ProjectDiscovery further. | ||
|
||
<CardGroup cols={3}> | ||
<Card title="Connect to Cloud Platform" icon="square-1" href="/cloud/introduction"> | ||
</Card> | ||
<Card title="Explore Open Source Tools" icon="square-2" href="/tools"> | ||
</Card> | ||
<Card title="Contribute to the Community" icon="square-3" href="https://github.com/projectdiscovery"> | ||
</Card> | ||
<Card title="Join the Community" icon="square-4" href="https://discord.gg/projectdiscovery"> | ||
</Card> | ||
<Card title="Run a Scan" icon="square-5" href="/nuclei/getting-started"> | ||
</Card> | ||
<Card title="Monitor Vulnerabilities" icon="square-6" href="/monitoring/introduction"> | ||
</Card> | ||
<Card title="Learn with Tutorials" icon="square-7" href="/tutorials"> | ||
</Card> | ||
<Card title="Dive into PDCP" icon="square-8" href="/cloud/features"> | ||
</Card> | ||
<Card title="Example Walkthrough" icon="square-9" href="/getstarted-example"> | ||
</Card> | ||
</CardGroup> | ||
|
||
**Check out the example** | ||
|
||
- [View the example](https://drive.google.com/file/d/1hdQpnferNOnUji20GHG7KBkJkGBY7u5w/view) | ||
- [Download the PDF](https://drive.google.com/uc?export=download&id=1hdQpnferNOnUji20GHG7KBkJkGBY7u5w) | ||
|
||
Move on to the next steps in the [example walkthrough](/getstarted-example) or: | ||
</Tip> | ||
|
||
- [View the example](https://drive.google.com/file/d/1hdQpnferNOnUji20GHG7KBkJkGBY7u5w/view) | ||
- [Download the PDF](https://drive.google.com/uc?export=download&id=1hdQpnferNOnUji20GHG7KBkJkGBY7u5w) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters