A professional lecture archive website built with MkDocs Material theme, showcasing weekly quantum computing lectures and monthly community events.
- 📚 Weekly Lectures: Comprehensive quantum computing content with video recordings
- 🎯 Monthly Events: Community meetups with workshops and networking
- 👥 Contributors: Team profiles with social media links
- 📖 Resources: Curated learning materials and tools
- 🔍 SEO Optimized: Meta descriptions, sitemap, and search engine friendly
- 📱 Responsive Design: Mobile-friendly with Material theme
- 🚀 Auto-Deployment: GitHub Actions workflow for seamless updates
- Python 3.11 or higher
- Git
-
Clone the repository
git clone https://github.com/GamalMoneep/Quantum_ai.git cd Quantum_ai -
Set up virtual environment
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
-
Install dependencies
pip install -r requirements.txt
-
Run locally
mkdocs serve
Visit
http://127.0.0.1:8000to view the site.
Quantum_ai/
├── docs/
│ ├── index.md # Homepage
│ ├── lectures/ # Weekly lectures
│ │ ├── index.md
│ │ ├── week-01.md
│ │ ├── week-02.md
│ │ └── week-03.md
│ ├── events/ # Monthly events
│ │ ├── index.md
│ │ └── january-2024.md
│ ├── resources/ # Learning resources
│ │ └── index.md
│ ├── contributors/ # Team profiles
│ │ └── index.md
│ └── assets/ # Images and styles
│ ├── stylesheets/
│ └── contributors/
├── .github/workflows/ # GitHub Actions
│ └── deploy.yml
├── mkdocs.yml # MkDocs configuration
├── requirements.txt # Python dependencies
└── README.md # This file
-
Create a new file in
docs/lectures/(e.g.,week-04.md) -
Use the template structure:
--- description: "Week 4: [Title] - [Brief description for SEO, 150-160 characters]" --- # Week 4: [Lecture Title] **Date:** YYYY-MM-DD **Duration:** X minutes **Last Updated:** YYYY-MM-DD ## Overview Brief description... ## Video [YouTube Link](https://youtube.com/watch?v=VIDEO_ID) ## Materials - [Slides (PDF)](github-link) - [Code Repository](github-link) ## Topics Covered - Topic 1 - Topic 2 ## Version History - **YYYY-MM-DD**: Initial release
-
Add to navigation in
mkdocs.yml -
Update
docs/lectures/index.mdwith a link
- Create a new file in
docs/events/(e.g.,february-2024.md) - Follow the same template structure as lectures
- Update navigation and overview page
- Page titles: Keep under 60 characters
- Meta descriptions: 150-160 characters, compelling and descriptive
- Headings: Use proper H1, H2, H3 hierarchy
- URLs: Keep clean and descriptive (MkDocs handles this automatically)
The site automatically deploys to GitHub Pages when you push to the main or master branch.
-
Push your changes
git add . git commit -m "Add new lecture: Week 4" git push origin master
-
Monitor deployment
- Check the GitHub Actions tab
- Deployment typically takes 2-3 minutes
- Site will be available at
https://gamalmoneep.github.io/Quantum_ai/
If needed, you can deploy manually:
mkdocs gh-deployEdit mkdocs.yml to customize:
- Colors and fonts
- Navigation structure
- Social media links
- SEO settings
Custom styles are in docs/assets/stylesheets/extra.css:
- Contributor card styling
- Responsive design improvements
- Custom button effects
- Track major updates with "Last Updated" timestamps
- Use version history sections for significant changes
- Keep version notes brief but informative
- Update dates when content changes
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-content) - Add your content following the templates
- Commit your changes (
git commit -m 'Add amazing content') - Push to the branch (
git push origin feature/amazing-content) - Open a Pull Request
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: your-email@example.com
This project is licensed under the MIT License - see the LICENSE file for details.
- MkDocs Material for the beautiful theme
- GitHub Pages for hosting
- The quantum computing community for inspiration and content
Built with ❤️ by the Quantum Computing Community