Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
Exemple Mkdocs DSFR
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
pub
Numérique et Écologie
Exemple Mkdocs DSFR
Commits
0129f198
Commit
0129f198
authored
1 year ago
by
Alexandre Caldato
Browse files
Options
Downloads
Patches
Plain Diff
update du readme. closes
#6
parent
bab18819
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+44
-8
44 additions, 8 deletions
README.md
with
44 additions
and
8 deletions
README.md
+
44
−
8
View file @
0129f198
# 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/
)
---
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment