Création d’un premier site

Pour créer votre premier site, créez un nouveau dossier et ouvrez une console dans ce répertoire.

Astuce

Si vous utilisez Visual Studio Code, vous pouvez ouvrir une console en tapant Ctrl+Shift+` ou en cliquant sur le menu Terminal et en choisissant New Terminal.

Si votre éditeur n’a pas de terminal intégré, nous vous recommandons d’utiliser Windows Terminal pour Windows, iTerm2 pour macOS, ou le terminal par défaut de votre distribution Linux.

Créez maintenant un nouveau projet avec la commande suivante:

uv init

Ajoutez maintenant les dépendances :

uv add properdocs
uv add mkdocs-materialx

Vous pouvez maintenant créer votre premier site properdocs avec la commande suivante :

uv run properdocs new .

puis tester avec

uv run properdocs serve -t materialx

Properdocs écrira ces quelques lignes dans la console :

INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 0.18 seconds
INFO    -  [12:40:37] Watching paths for changes: 'docs', 'properdocs.yml'
INFO    -  [12:40:37] Serving on http://127.0.0.1:8000/
INFO    -  [12:40:42] Browser connected: http://127.0.0.1:8000/

et en ouvrant votre navigateur à l’adresse http://127.0.0.1:8000/, vous devriez voir le résultat suivant :

Félicitations! Vous venez de créer un site web avec properdocs.