Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.54 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.54 KB
title description
laurent-laporte-pro.github.io
A Python package to install my personal website.

Curriculum Vitæ de Laurent LAPORTE

Table des matières

Installation

Ce projet Python permet de générer mon site web personnel.

Il utilise le gestionnaire de projet hatch pour gérer les dépendances, les tâches de construction et de déploiement de la documentation sur GitHub Pages.

⇨ Consultez la documentation de hatch pour installer cette commande sur votre machine.

Remarque : en général, on installe hatch de manière globale et non pas dans un environnement virtuel.

Génération de la documentation

Pour générer la documentation, nous utilisons mkdocs. Cette bibliothèque permet de générer un site web statique à partir de fichiers Markdown.

Pour construire la documentation, exécutez la commande suivante :

hatch run mkdocs build

Pour visualiser la documentation en local, exécutez la commande suivante :

hatch run mkdocs serve

Pour déployer la documentation sur GitHub Pages, exécutez la commande suivante :

hatch run mkdocs gh-deploy

Licence

Ce projet est privé et ne peut être utilisé sans l'autorisation de l'auteur.

Consultez le fichier LICENCE.md pour plus d'informations.