mirror of
https://github.com/Snigdha-OS/Snigdha-OS.github.io.git
synced 2025-09-05 20:26:43 +02:00
68 lines
3.3 KiB
Markdown
68 lines
3.3 KiB
Markdown
# Snigdha OS Website 🌐
|
||
|
||
Welcome to the **Snigdha OS** website repository! This repository powers the official site for **Snigdha OS**, an Arch-based Linux distribution focused on penetration testing and ethical hacking. Here, you will find documentation, guides, and all resources to help you get the most out of Snigdha OS.
|
||
|
||
## 🚀 About Snigdha OS
|
||
|
||
**Snigdha OS** is an Arch Linux-based operating system designed for ethical hackers and penetration testers. It is lightweight, highly customizable, and pre-loaded with a suite of security tools. Whether you're performing security audits or simply looking for a minimalistic and powerful OS, **Snigdha OS** has you covered!
|
||
|
||
### Key Features:
|
||
- **Arch-based**: Fast, flexible, and rolling release.
|
||
- **Penetration Testing Ready**: Pre-loaded with security tools like **Blackbox**.
|
||
- **Highly Customizable**: Tailor the OS to your needs.
|
||
- **Efficient**: Minimal design for better performance.
|
||
|
||
Learn more at the official [Snigdha OS Documentation](https://snigdhaos.org).
|
||
|
||
## 🛠️ Technologies Used
|
||
|
||
- **Astro**: Modern static site generator that ensures fast, optimized websites. 🚀
|
||
- **Starlight**: Component library for documentation sites built on Astro. 📚
|
||
- **Markdown & MDX**: Content is written in Markdown for easy updates and collaboration. ✍️
|
||
|
||
## 📂 Repository Structure
|
||
|
||
Here’s an overview of the project structure:
|
||
```
|
||
.
|
||
├── .github # GitHub configuration
|
||
├── assets # Website assets
|
||
│ ├── icons # Icons used for the site
|
||
├── .gitignore # Git ignore file
|
||
├── config.sh # Shell configuration script
|
||
├── developers.css # CSS for the developer section
|
||
├── developers.html # HTML for the developer section
|
||
├── developers.js # JavaScript for the developer section
|
||
├── index.html # Main HTML file for the site
|
||
├── push.sh # Deployment script
|
||
├── sitemap.xml # Sitemap for SEO
|
||
└── style.css # Global CSS for the site
|
||
```
|
||
## 🧑💻 How to Contribute
|
||
|
||
We welcome contributions to improve the Snigdha OS website! Here’s how you can get started:
|
||
|
||
1. **Fork the Repository**: Click the fork button at the top-right of the page to create your own copy of the repository. 🍴
|
||
2. **Clone the Repository**: Clone the repo to your local machine.
|
||
```bash
|
||
git clone https://github.com/Snigdha-OS/Snigdha-OS.github.io.git
|
||
cd Snigdha-OS.github.io
|
||
```
|
||
3. **Install Dependencies**: Install the necessary dependencies.
|
||
```bash
|
||
pnpm install
|
||
```
|
||
4. **Run the Development Server**: Start the local development server to preview your changes.
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
5. **Make Changes**: Add new documentation, fix bugs, or improve the site’s design. 🛠️
|
||
6. **Create a Pull Request**: Once you're happy with your changes, submit a pull request! 🚀
|
||
|
||
For detailed guidance on contributing, refer to our [Contributing Guide](https://github.com/Snigdha-OS/Snigdha-OS.github.io/blob/main/CONTRIBUTING.md). 🤝
|
||
|
||
## 🌍 Support
|
||
|
||
If you need help or have any questions, feel free to reach out:
|
||
- Join the community on our [Snigdha OS Discord Server](https://discord.gg/snigdhaos) 💬
|
||
- Open an issue in the [GitHub Issues](https://github.com/Snigdha-OS/Snigdha-OS.github.io/issues) tracker 🐞 |