ForgeFolio - Documentation - Hébergement de portfolio BTS SIO

Documentation technique du projet ForgeFolio, une infrastructure web destinée à héberger les portfolios des étudiants en BTS SIO (Initialement conçus pour le BTS SIO du lycée Paul-Louis-Courier).

---

Le projet apporte un cadre reproductible pour publier des portfolios étudiants, alors que les notions d'infrastructure et d'exploitation sont peu présentes dans le parcours de développement (BTS SIO SLAM). La documentation décrit les choix d'architecture, la configuration du VPS et d'Apache, les mesures de sécurité, ainsi que les procédures de déploiement et de maintenance.

Le site est généré avec MkDocs et le thème Material for MkDocs. Les modifications poussées sur main sont publiées automatiquement par GitHub Actions.

Documentation en ligne : forgefolio-docs

Une migration vers Zensical est prévue.

---

Structure du projet

.
├── .github/
│   └── workflows/
├── docs/
│   ├── assets/
│   ├── index.md
│   └── cahier-des-charges.md
├── templates/
└── mkdocs.yaml

• .github/workflows/ : Contient le pipeline CI/CD (publish.yaml) chargeant la génération et le déploiement automatique du site lors d'un push sur la branche main.
• docs/ : Répertoire source contenant les pages de la documentation au format Markdown (.md) ainsi que les médias dans le sous-dossier assets/.
• mkdocs.yaml : Fichier de configuration principal définissant la navigation, le thème visuel et les extensions du site.
• templates/ : Répertoire contenant les modèles de documents réutilisables pour structurer la documentation du projet.

---

Comment utiliser le projet en local

1. Cloner le dépôt et y accéder

git clone git@github.com:FireToak/forgefolio-docs.git
cd forgefolio-docs

• git clone <url> : Télécharge une copie complète du dépôt distant sur ton poste de travail local.
• cd <dossier> : (Change Directory) Modifie ton répertoire de travail actuel pour entrer dans le dossier du projet.

2. Installer les dépendances

pip install mkdocs-material

• pip install ... : Utilise le gestionnaire de paquets de Python pour télécharger et installer la bibliothèque mkdocs-material, requise pour compiler le site avec l'interface visuelle choisie.

3. Lancer le serveur de développement

mkdocs serve

• mkdocs serve : Démarre un mini-serveur web local (généralement accessible sur http://127.0.0.1:8000). Cette commande surveille tes fichiers et recharge automatiquement la page web dans ton navigateur dès que tu sauvegardes une modification dans un fichier Markdown. Idéal pour tester le rendu avant publication.

---

Mainteneurs

Louis MEDO | Linkedin | Portfolio | GitHub

---

Dernière mise à jour : 28 août 2026