96d5300d954f6890e57699e9ef1e9001b22d76a8
HEC IA Wiki 🤖
The official wiki and knowledge base for HEC IA student association. Built with Astro and the AstroPaper theme.
📚 About
This wiki serves as a central hub for HEC IA's content, including:
- Events: Information about upcoming and past events
- Workshops: Hands-on technical workshops and tutorials
- News: Latest updates and announcements from HEC IA
- Technical Deep Dives: In-depth technical articles on AI topics
🚀 Quick Start
Prerequisites
- Node.js 18+
- npm or pnpm
Installation
# Clone the repository
git clone https://github.com/hec-ia/wiki.git
cd wiki
# Install dependencies
npm install
# Start development server
npm run dev
The site will be available at http://localhost:4321
Building for Production
# Build the site
npm run build
# Preview the build
npm run preview
📝 Adding Content
Events
Create a new markdown file in src/data/events/:
---
title: "Your Event Title"
description: "Event description"
author: "HEC IA"
pubDatetime: 2026-01-15T10:00:00Z
eventDate: 2026-02-05T14:00:00Z
eventEndDate: 2026-02-05T18:00:00Z
location: "Event Location"
tags: ["tag1", "tag2"]
featured: true
registrationLink: "https://registration-link.com"
---
Your event content here...
Workshops
Create a new markdown file in src/data/workshops/:
---
title: "Workshop Title"
description: "Workshop description"
author: "HEC IA"
pubDatetime: 2026-01-15T10:00:00Z
workshopDate: 2026-02-05T14:00:00Z
duration: "3 hours"
level: "beginner" # beginner, intermediate, or advanced
tags: ["machine-learning", "python"]
featured: true
materials: "https://github.com/hec-ia/workshop-materials"
---
Your workshop content here...
News
Create a new markdown file in src/data/news/:
---
title: "News Title"
description: "News description"
author: "HEC IA"
pubDatetime: 2026-01-25T10:00:00Z
tags: ["news", "announcement"]
featured: true
---
Your news content here...
Technical Deep Dives
Create a new markdown file in src/data/technical/:
---
title: "Technical Article Title"
description: "Article description"
author: "HEC IA Technical Team"
pubDatetime: 2026-01-28T10:00:00Z
tags: ["deep-learning", "nlp"]
difficulty: "advanced" # beginner, intermediate, or advanced
readingTime: "25 min"
featured: true
---
Your technical content here...
🎨 Customization
Site Configuration
Edit src/config.ts to customize:
- Site title and description
- Author information
- Social links
- Posts per page
- And more...
Theme Colors
The site uses Tailwind CSS. Customize colors in:
src/styles/base.cssfor global stylestailwind.config.jsfor theme configuration
📂 Project Structure
/
├── public/
│ └── assets/ # Static assets
├── src/
│ ├── assets/ # SVG icons and images
│ ├── components/ # Astro components
│ ├── data/ # Content collections
│ │ ├── events/
│ │ ├── workshops/
│ │ ├── news/
│ │ └── technical/
│ ├── layouts/ # Page layouts
│ ├── pages/ # Route pages
│ ├── styles/ # Global styles
│ ├── utils/ # Utility functions
│ ├── config.ts # Site configuration
│ └── content.config.ts # Content collections config
├── astro.config.ts
├── package.json
└── README.md
🧞 Available Commands
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run format:check |
Check code format with Prettier |
npm run format |
Format codes with Prettier |
npm run sync |
Generates TypeScript types for all Astro modules |
npm run lint |
Lint with ESLint |
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
Built with:
- Astro - The web framework for content-driven websites
- AstroPaper - The base theme
- Tailwind CSS - For styling
- TypeScript - For type safety
Made with ❤️ by HEC IA
Languages
Astro
61.4%
TypeScript
21%
JavaScript
12.6%
CSS
4%
Dockerfile
1%
