Skip to content
Snippets Groups Projects
Commit 0129f198 authored by Alexandre Caldato's avatar Alexandre Caldato
Browse files

update du readme. closes #6

parent bab18819
No related branches found
No related tags found
No related merge requests found
# Exemple mkdocs-dsfr # Exemple d'Utilisation de mkdocs-dsfr
## Usage Ce dépôt sert d'exemple pour le thème mkdocs-dsfr, un thème mkdocs conforme aux standards de l'État français pour la création de sites Web.
- Prérequis : [pipenv](https://pipenv.pypa.io/en/latest/) ## Prérequis
- Environnement de travail :
- `pipenv install`pour installer les dépendances
- `pipenv shell`pour entrer dans le venv
- `mkdocs serve`pour tester en live
- `mkdocs build`pour construire le site
- [Python 3.x](https://www.python.org/downloads/)
- [pipenv](https://pipenv.pypa.io/en/latest/)
## Installation
1. Clonez ce dépôt sur votre machine locale.
2. Ouvrez un terminal et naviguez vers le dossier du projet.
3. Exécutez `pipenv install` pour installer les dépendances du projet.
## Utilisation
### Environnement de Développement
1. Entrez dans l'environnement virtuel avec `pipenv shell`.
2. Lancez le serveur de développement avec `mkdocs serve`.
3. Ouvrez votre navigateur Web et accédez à `http://127.0.0.1:8000`.
### Construction du Site
Pour construire le site Web statique, utilisez la commande suivante :
```bash
mkdocs build
```
Le site sera généré dans le dossier `site`.
## Contributeurs
Ce projet est une initiative du gouvernement français pour promouvoir les standards de développement Web en France.
## Licence
À définir
## Ressources Utiles
- [Site officiel de DSFR](https://www.systeme-de-design.gouv.fr/)
- [Documentation mkdocs](https://www.mkdocs.org/)
---
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment