Template de site web pour IFT3150

Ce projet est un template de site web pour le cours IFT3150, construit avec MkDocs et le thème Material for MkDocs.

Prérequis

Assurez-vous d’avoir les outils suivants installés :

• Python 3.11 ou plus récent
• pip (gestionnaire de paquets Python)

Installation

1. Clonez ce dépôt (optionnel) :

git clone git@github.com:udem-diro/template-projet.git

2. Installez les dépendances (dans votre répertoire) :

pip install -r requirements.txt

Utilisation

Développement local

Pour lancer un serveur de développement local :

mkdocs serve

Le site sera accessible à l'adresse http://127.0.0.1:8000

Construction du site

Pour construire le site :

mkdocs build

Les fichiers générés seront dans le dossier site/.

Déploiement

Pour déployer sur GitHub Pages :

mkdocs gh-deploy

Cette commande pousse automatiquement le contenu du site sur la branche gh-pages.

Structure du projet

• docs/ : Contient tous les fichiers Markdown du site
• mkdocs.yml : Configuration de MkDocs
• requirements.txt : Dépendances Python
• site/ : Site généré (créé lors de la construction)

Personnalisation

1. Modifiez mkdocs.yml pour changer la configuration du site
2. Ajoutez/modifiez les fichiers Markdown (.md) dans docs/
3. Personnalisez le thème en modifiant les paramètres dans mkdocs.yml

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

🙋‍♀️ Questions ou problèmes ?

En cas de problème, n'hésitez pas à ouvrir une issue sur GitHub ou à poser des questions au responsable du cours.