Merge pull request #373 from Abhishek-Sood/main

Documentation added using mkdocs

.github/workflows/mkdocs.yaml

@@ -0,0 +1,63 @@
+name: MK Docs
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+      - "Documentation-*"
+  pull_request_target:
+
+jobs:
+  build:
+    name: Build MkDocs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('mkdocs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: pip install -r mkdocs/requirements.txt
+
+      - name: Build MK Docs project
+        run: mkdocs build -f mkdocs/mkdocs.yml
+
+      - name: Upload MK Docs build files
+        uses: actions/upload-artifact@v4
+        with:
+          name: mkdocs-files
+          path: ./mkdocs/site
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/tags/Documentation-')
+
+    steps:
+      - name: Download MkDocs artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: mkdocs-files
+          path: ./mkdocs/site
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GH_PAGES_TOKEN }}
+          publish_dir: ./mkdocs/site

mkdocs/docs/aboutus.md

@@ -0,0 +1,59 @@
+# CosmoXplore
+
+Welcome to CosmoXplore, your gateway to the marvels of the universe! We are dedicated to making space exploration accessible and captivating for everyone, from seasoned enthusiasts to curious minds.
+
+## 🌌 Our Vision
+
+At CosmoXplore, we have a bold vision of democratizing space exploration. Our mission is to inspire and educate individuals about the wonders of the cosmos while staying at the forefront of technological advancements in space science and exploration.
+
+## 🛰️ Our Project
+
+### Bringing Space Closer to You
+
+Our platform is designed to immerse you in the cosmos through stunning visuals and insightful content. We feature the Astronomy Picture of the Day (APOD) to showcase the beauty of the universe in a captivating way. Explore mesmerizing photos of Mars, get updates on NASA's latest missions, and delve into space-related news and discoveries.
+
+### NASA's Open API Integration
+
+CosmoXplore leverages NASA's open API to provide a seamless and interactive experience. Through this integration, we bring you real-time data, images, and information directly from NASA's extensive repository. Stay informed and engaged with the latest happenings in space exploration.
+
+### Community Collaboration
+
+As an open-source organization, collaboration is at the heart of CosmoXplore. We encourage contributions from passionate individuals, researchers, and space enthusiasts worldwide. Together, we strive to expand our knowledge, share discoveries, and foster a community of space exploration enthusiasts.
+
+## 🚀 Our Methods
+
+### Curated Content
+
+Our team curates high-quality content, including articles, news updates, and educational resources, to keep you informed and inspired about space exploration.
+
+### User-Friendly Interface
+
+CosmoXplore is designed with user experience in mind. Our intuitive interface makes it easy to navigate, discover new content, and engage with the cosmos.
+
+### Technological Advancements
+
+We embrace cutting-edge technologies to enhance your experience. From interactive features to immersive visuals, we aim to provide an engaging platform for space enthusiasts of all ages.
+
+## 👨‍🚀 Our Team
+
+### Founder:
+- Pranav Barthwal
+
+### Contributors:
+- Donald Reddy
+- Chandu6702
+- Anjaliavv51
+- Pradeeptosarkar
+- Surajvast1
+- Suhanipaliwal
+- Shaurya35
+- RamakrushnaBiswal
+- and many more...
+
+## 🌌 Join Our Cosmic Journey
+
+We are grateful for the dedication and contributions of our team members, each bringing unique skills and perspectives to CosmoXplore.
+
+Join us on this cosmic journey as we explore the wonders of the universe together. Whether you're a seasoned space enthusiast or just starting your journey of discovery, CosmoXplore welcomes you to dive into the mysteries and beauty of outer space.
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/gettingstarted.md

@@ -0,0 +1,59 @@
+# Getting Started with CosmoXplore
+
+## 🌠 Explore Our Tech Stack
+
+CosmoXplore is built using modern web technologies including HTML5, JavaScript, CSS3, and React. Our tech stack ensures a seamless and engaging experience for users as they delve into the wonders of space exploration.
+
+<a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5"><img src="https://img.shields.io/badge/HTML5-E34F26.svg?style=for-the-badge&logo=HTML5&logoColor=white"></a>
+<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript"><img src="https://img.shields.io/badge/JavaScript-F7DF1E.svg?style=for-the-badge&logo=JavaScript&logoColor=black"></a>
+<a href="https://developer.mozilla.org/en-US/docs/Web/CSS"><img src="https://img.shields.io/badge/CSS3-1572B6.svg?style=for-the-badge&logo=CSS3&logoColor=black"></a>
+<a href="https://developer.mozilla.org/en-US/docs/Web/React"><img src="https://img.shields.io/badge/React-1572B6.svg?style=for-the-badge&logo=React&logoColor=black"></a>
+
+
+---
+
+## 🚀 How to Contribute
+
+We welcome contributions from developers, designers, space enthusiasts, and anyone passionate about space exploration. Follow these steps to get started:
+
+- **Clone the Repository:** Clone the CosmoXplore repository to your local environment.
+
+   ```bash
+   git clone https://github.com/<your-github-username>/cosmoXplore.git
+   ```
+
+- **Install Dependencies:** Use npm or yarn to install the required packages and dependencies.
+
+   ```bash
+   cd cosmoXplore
+   ```
+
+- **Add Environment Variables:** Create a `.env` file and add necessary environment variables as per the instructions in the repository.
+
+   ```bash
+   npm install
+   ```
+
+- **Start the Server:** Launch the development server to view and test your changes locally.
+
+   ```bash
+   npm run dev
+   ```
+
+- **Local Host:** Access the project on your local host at:
+
+   ```bash
+   http://localhost:5173/
+   ```
+
+- **Contribute:** Explore the project, find areas to contribute such as improving UI/UX, adding new features, fixing bugs, or contributing to documentation. Submit pull requests to collaborate with the community.
+
+---
+
+## 🌌 Join Our Community
+
+Become a part of the vibrant CosmoXplore community. Connect with fellow enthusiasts, share ideas, learn, and contribute to our shared mission of making space exploration accessible and captivating for all.
+
+---
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/index.md

@@ -0,0 +1,35 @@
+# Welcome to CosmoXplore
+
+**Discover the Universe with CosmoXplore**
+
+![GitHub issues](https://img.shields.io/github/issues/PranavBarthwal/cosmoXplore) <br>
+![GitHub contributors](https://img.shields.io/github/contributors/PranavBarthwal/cosmoXplore) <br>
+![GitHub Repo stars](https://img.shields.io/github/stars/PranavBarthwal/cosmoXplore?style=social) <br>
+---
+
+## 🌌 CosmoXplore Features
+
+### Astronomy Picture of the Day (APOD)
+Explore breathtaking images of celestial wonders updated daily.
+
+### Martian Images
+Get a glimpse of Mars with captivating photos captured by spacecraft.
+
+### NASA Projects
+Stay updated with the latest projects and missions from NASA.
+
+---
+
+## 🚀 Join Our Journey
+Experience the wonders of space exploration with CosmoXplore. Join us in discovering the mysteries and beauty of the cosmos!
+
+---
+
+## Contributors
+
+We extend our gratitude to all contributors who have made CosmoXplore possible. Your contributions are highly appreciated!
+
+Show your support by giving ⭐ to our repository.
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>
+

mkdocs/mkdocs.yml

@@ -0,0 +1,62 @@
+site_name: CosmoXplore
+site_author: PranavBarthwal
+docs_dir: Docs
+
+theme:
+  name: material
+  feature:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotations
+    - content.code.copy
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+      primary: deep purple
+      accent: deep purple
+    - scheme: slate
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+      primary: slate
+      accent: lime
+  language: en
+  logo: favicon.ico
+  favicon: favicon.ico
+
+repo_url: https://github.com/PranavBarthwal/cosmoXplore
+repo_name: CosmoXplore
+
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.mark
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+
+nav:
+  - Home: index.md
+  - About Us: aboutus.md
+  - Getting Started: gettingstarted.md
+
+
+copyright: |
+  &copy; 2024 <a href="https://github.com/PranavBarthwal/cosmoXplore"  target="_blank" rel="noopener">CosmoXplore</a>

mkdocs/requirements.txt

@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material

package.json

@@ -17,6 +17,7 @@
     "@tsparticles/all": "^3.4.0",
     "@tsparticles/react": "^3.0.0",
     "html-to-react": "^1.7.0",
+    "mkdocs": "^0.0.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-icons": "^5.2.1",