|
1 | | -# Nmap-Script-Search-Guide |
| 1 | +# Nmap NSE Script Notes |
| 2 | + |
| 3 | +This repository contains educational notes for Nmap's NSE (Nmap Scripting Engine) scripts. It is designed for learning and practical reference for penetration testers and students. |
| 4 | + |
| 5 | +Live site: [https://giriaryan694-a11y.github.io/Nmap-Script-Search-Guide/](https://giriaryan694-a11y.github.io/Nmap-Script-Search-Guide/) |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Clean, educational notes on Nmap NSE |
| 10 | +- Types of scripts explained (Discovery, Vulnerability, Brute) |
| 11 | +- Searching scripts using `cat` & `grep` |
| 12 | +- NSE script categories |
| 13 | +- Writing your first NSE script example |
| 14 | +- Interactive sidebar navigation |
| 15 | +- Search filter for code blocks |
| 16 | +- Copy buttons for commands |
| 17 | +- Dark/Light theme toggle with preference saved in cookies |
| 18 | +- Fully responsive for desktop and mobile screens |
| 19 | + |
| 20 | +## GitHub Pages |
| 21 | + |
| 22 | +This repository is ready to be published as a GitHub Pages site. Steps: |
| 23 | + |
| 24 | +1. Clone or fork the repository. |
| 25 | +2. Ensure `index.html` is in the root of the repository. |
| 26 | +3. Go to **Settings > Pages**. |
| 27 | +4. Under **Source**, select `main` branch and root folder. |
| 28 | +5. Click **Save**. |
| 29 | +6. Your site will be available at `https://giriaryan694-a11y.github.io/Nmap-Script-Search-Guide/` |
| 30 | + |
| 31 | +## Usage |
| 32 | + |
| 33 | +- Open `index.html` in a browser to view notes. |
| 34 | +- Click the **hamburger menu** (top-left) to open navigation. |
| 35 | +- Click **Toggle Theme** (top-right) to switch between dark/light themes. |
| 36 | +- Use the **search box** in the sidebar to filter commands. |
| 37 | +- Click **Copy** on any code block to copy its contents. |
| 38 | + |
| 39 | +## Author |
| 40 | + |
| 41 | +Made by Aryan • Educational Notes on Nmap NSE |
| 42 | + |
| 43 | +## License |
| 44 | + |
| 45 | +This project is for educational purposes. Do not use maliciously. |
0 commit comments