https://github.com/rohancyberops/ai-for-beginners.github.io
https://github.com/rohancyberops/ai-for-beginners.github.io
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rohancyberops/ai-for-beginners.github.io
- Owner: RohanCyberOps
- Created: 2024-11-16T09:13:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-28T15:08:00.000Z (over 1 year ago)
- Last Synced: 2025-07-19T11:02:44.480Z (11 months ago)
- Language: TypeScript
- Size: 3.66 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# AI for Beginners Documentation 🌟
Welcome to the **AI for Beginners** documentation! This repository serves as an interactive guide to help you learn and explore the fundamentals of Artificial Intelligence (AI). 🚀 Whether you're just starting or looking to refresh your knowledge, this is the perfect place for you!
---
## 📖 Features
- Learn essential AI concepts such as **Machine Learning**, **Natural Language Processing**, and **Computer Vision**.
- Engage with **Interactive Quizzes** to test and solidify your knowledge. 🧠
- Fully dynamic and responsive documentation site for easy navigation.
---
## 🛠️ How to Use
### **1. Clone the Repository**
Clone the repository to your local machine and navigate into the project folder:
```bash
git clone https://github.com/chrohangurjar1/ai-for-beginners.git
cd ai-for-beginners
```
### **2. Install [Docsify](https://docsify.js.org/)**
To run the documentation locally, you'll need to install [Docsify](https://docsify.js.org/):
```bash
npm install -g docsify-cli
```
### **3. Start the Local Server**
Run the following command to serve the documentation locally:
```bash
docsify serve ./docs
```
Visit your browser at `http://localhost:3000` to explore the documentation site.
---
## 📂 Project Structure
Here’s an overview of the project's file structure:
```
├── docs/
│ ├── README.md # Home page
│ ├── introduction.md # Introduction to AI
│ ├── machine-learning.md # Machine Learning Guide
│ ├── quizzes.md # Interactive Quizzes
│ └── _sidebar.md # Sidebar for navigation
├── .gitignore # Ignored files
├── package.json # Project dependencies
└── README.md # This file
```
---
## 🚀 Deploy Your Site
Easily deploy your Docsify documentation to **GitHub Pages**:
### **1. Push to GitHub**
Push the repository to GitHub:
```bash
git add .
git commit -m "Initial commit"
git push origin main
```
### **2. Create a `gh-pages` Branch**
Deploy your documentation to GitHub Pages:
```bash
git checkout -b gh-pages
git push origin gh-pages
```
### **3. Configure GitHub Pages**
Go to your GitHub repository’s **Settings > Pages**, and set the source to `gh-pages`.
Your documentation will be live at [https://chrohangurjar.github.io/AI-For-Beginners.github.io/](https://chrohangurjar.github.io/AI-For-Beginners.github.io/)! 🎉
---
## 👨💻 Contribute
We welcome contributions! Feel free to:
- Add new chapters or resources.
- Improve existing quizzes and interactive elements.
- Report bugs or suggest new features.
### **How to Contribute**
1. Fork the repository.
2. Create a new branch for your changes.
3. Submit a pull request with your updates.
---
## 📜 License
This project is licensed under the **MIT License**. You’re free to use, modify, and distribute it as you wish.
---
### 📢 Stay Connected!
Follow me on social media to stay updated with new projects and updates:
- **GitHub**: [Rohan Naagar](https://github.com/chrohangurjar1)
- **LinkedIn**: [Rohan Naagar](#)
- **Twitter**: [Rohan Naagar](#)
---