diff --git a/README.md b/README.md index 000ea3455fa1226682a1b9dee6a720de44b0bcef..f2f81a6b0739e37655a26827f59d69496dd718cf 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ -# Welcome to MkDocs +# Exemple mkdocs-dsfr -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +## Usage -## Commands +- Prérequis : [pipenv](https://pipenv.pypa.io/en/latest/) +- 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 -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files.