Monolithe
Monolithe regroupe plusieurs documents utiles au format Markdown au même endroit. C'est pratique. C'est simple.
Installation
Monolithe utilise le framework nodeJs Docusaurus pour construire un site statique. Il est nécessaire que NodeJs soit installé en version 18.0 ou plus. Il suffit donc de cloner le répertoire Gitlab et de lancer les commandes :
npm install
npm run build
Cela construira toutes les sources nécessaires au bon fonctionnement du site dans le dossier build.
Déploiement Local
Il est possible de déployer Monolithe en local, sur le port par défaut 3000. Pour cela, il faut exécuter les commandes :
npm install
npm run start
Une page web à l'adresse http://localhost:3000 devrait se lancer.
Déploiement
Pour le déploiement en production, Monolithe utilise un pipeline Gitlab CI pour construire les sources. Une fois les sources construites, elles sont déplacées dans un dossier nommé public. Pour l'hébergement web, c'est Gitlab Pages qui s'en occupe. En effet, Gitlab Pages permet d'héberger des sites web statiques grâce à la balise :
pages:
publish: public
Tout le contenu du dossier public sera utilisé pour le site.
Bonnes pratiques
- Tous les documents sont à placer dans
/docs. - Les images sont à placer dans le dossier
/static/img/monDossier/. - Une image ne doit pas dépasser les 150Ko et doivent être en .webp.
- Pour redimensionner une image et la convertir, on peut aller sur Squoosh.