RAID Blogs

🌐 Live Site

The official blog of RAID, the AI & ML society at IIT Jodhpur. Built with Astro 🚀, this site hosts articles, tutorials, and updates on artificial intelligence 🤖, machine learning 🧠, and data science 📊 from the RAID community.

---

📚 Table of Contents

• Features ✨
• Installation 🛠️
• Contribution Guidelines 🤝
• Project Structure 📁
• Credits 🙌

---

Features

• Minimal and performant Astro-based blog ⚡
• SEO-friendly (OpenGraph, canonical URLs, sitemap, RSS feed) 🔍
• Markdown & MDX support for writing posts ✍️
• Styled with TailwindCSS 🎨
• Responsive and accessible design 📱

---

Installation

✅ Prerequisites

• Node.js (version 18 or higher recommended)
• npm (comes with Node.js)

🚀 Setup Steps

1. Clone the repository

   git clone https://github.com/AISocietyIITJ/blogs-raid.git
   cd blogs-raid

2. Install dependencies

   npm install

3. Start the development server

   npm run dev

   The site should now be available at http://localhost:4321 🌐

4. Build for production

   npm run build

5. Preview your build

   npm run preview

---

Contribution Guidelines

We welcome contributions! 💡 Please follow these guidelines to keep our community constructive and inclusive 🌟

📜 Code of Conduct

• Be respectful and considerate 🤝
• Assume good intent and offer constructive feedback ✨
• Harassment or inappropriate behavior will not be tolerated 🚫

🔧 How to Contribute

1. Fork the repository 🍴

Click “Fork” on the top right of the main repository page.

2. Clone your fork

git clone https://github.com/YOUR-USERNAME/blogs-raid.git
cd blogs-raid

3. Create a new branch 🌿

Use a descriptive name:

git checkout -b fix/correct-footer-link
# or
git checkout -b feat/add-new-blog-template

4. Make your changes 🛠️

• Keep the code clean and comment where needed 🧼
• Follow the existing code style 🎨

5. Commit with a detailed message 📝

git commit -m "fix: corrected footer GitHub link to point to organization"

6. Push to your fork 🚀

git push origin your-branch-name

7. Open a Pull Request (PR) 📬

• Go to your fork on GitHub and click “Compare & pull request”
• Fill in a detailed title and thorough description of your changes
• Be polite and constructive in your comments and code reviews 🙏

Example of a good PR title and description:

Title: fix: correct LinkedIn link in footer

Description: The footer LinkedIn icon was pointing to a personal profile. Updated it to point to the RAID IITJ organization page. Also added a hover effect for better UX.

All PRs must:

• Be respectful and constructive 🧠
• Clearly describe what and why you changed ✍️
• Reference related issues (e.g., Closes #6) 🔗

---

Project Structure

├── public/
├── src/
│   ├── components/
│   ├── content/
│   ├── layouts/
│   └── pages/
├── astro.config.mjs
├── package.json
├── README.md
└── tsconfig.json

• src/pages/: Route-based content (e.g., blog, about) 📄
• src/components/: Reusable UI components 🧩
• src/layouts/: Blog and page layouts 🧱
• src/content/: Markdown posts ✍️

---

Credits

This project is based on the Astro Blog Starter Kit and inspired by Bear Blog 🐻

---

For more, visit the Astro documentation 📚

---

Maintained by RAID, IIT Jodhpur. Contributions welcome! 💙