You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/stories/docs/01-intro.stories.mdx
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,20 +5,30 @@ import MailIcon from './mail-fill.svg'
5
5
6
6
<Metatitle="Docs/1. Introduction" />
7
7
8
-
# Qu'est-ce que VueDsfr
8
+
##Qu'est-ce que VueDsfr
9
9
10
10
VueDsfr est un **portage** du [**Système de design français**](https://www.systeme-de-design.gouv.fr/)
11
11
en [**Vue 3**](https://v3.vuejs.org/) sous forme de **bibliothèque de composants**.
12
12
13
13
Le code est [ouvert et disponible sur <imgsrc={GithubIcon}style={{height: '1.25rem', 'position': 'relative', top: '0.25rem' }} /> GitHub](https://github.com/dnum-mi/vue-dsfr)
14
14
15
-
# Comment débuter
15
+
##Comment débuter
16
16
17
17
Pour commencer à l’utiliser, [c’est par ici !](/story/docs-2-guide-d-utilisation--page)
18
18
19
19
Pour **migrer vers la version 3.x, [c’est par ici !](/docs/docs-4-migrations--docs)**
20
20
21
-
# Les acteurs du projet
21
+
## Rejoindre le serveur Discord
22
+
23
+
Si vous souhaitez participer au projet, poser une question, émettre une critique (ou nous faire des éloges, elles seront bienvenues aussi), nous vous invitons à rejoindre le serveur Discord grâce à ce lien d’invitation :
Copy file name to clipboardExpand all lines: src/stories/docs/02-guide.stories.mdx
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,14 @@ import { Meta } from '@storybook/addon-docs';
2
2
3
3
<Metatitle="Docs/2. Guide d’utilisation" />
4
4
5
-
# Comment débuter
5
+
# Utiliser VueDsfr
6
+
7
+
## Comment débuter
6
8
7
9
Ceci est le guide d̛’utilisation de la bibliothèque. Si vous cherchez à contribuer, se référer au
8
10
[Guide du développeur](?path=/story/docs-guide-du-développeur--page).
9
11
10
-
## Utiliser create-vue-dsfr (recommandé)
12
+
###Utiliser create-vue-dsfr (recommandé)
11
13
12
14
La façon la plus simple de commencer un projet est d’utiliser le package `create-vue-dsfr`, qui permet de créer un projet
13
15
NPM avec tout le nécessaire pour développer un projet utilisant VueDsfr, que ce soit pour Vite (Vue3) ou pour Nuxt 3 (Nuxt3),
@@ -33,26 +35,26 @@ yarn create vue-dsfr
33
35
34
36
Et suivez le guide !
35
37
36
-
## Ajouter la bibliothèque
38
+
###Ajouter la bibliothèque
37
39
38
-
### Utiliser la bibliothèque en tant que plugin
40
+
####Utiliser la bibliothèque en tant que plugin
39
41
40
42
| Notes : |
41
43
|:---------------------------|
42
44
| Pour utiliser cette bibliothèque, il vous faudra **[Vue 3](https://v3.vuejs.org/)** (et **[Vue-Router 4](https://next.router.vuejs.org/)**). Par conséquent, si vous utilisez Nuxt, il vous faut **[Nuxt 3](https://v3.nuxtjs.org/)** (plus de détails plus loin). |
43
45
| Il est fortement conseillé d’utiliser **[Vite](https://vitejs.dev)** plutôt que Vue-CLI. |
44
46
45
-
### Installer la bibliothèque en tant que dépendance du projet
47
+
####Installer la bibliothèque en tant que dépendance du projet
46
48
47
49
Afin d'installer la bibliothèque, taper cette commande dans votre console au sein du répertoire du projet :
48
50
49
51
```shell
50
52
npm install @gouvminint/vue-dsfr
51
53
```
52
54
53
-
### Ajouter le plugin
55
+
####Ajouter le plugin
54
56
55
-
#### Dans une application Vite (recommandé) ou Vue-CLI
57
+
#####Dans une application Vite (recommandé) ou Vue-CLI
56
58
57
59
À partir d'un fichier `main.js` simple comme celui-ci :
58
60
@@ -80,7 +82,7 @@ const app = createApp(App)
80
82
.mount('#app')
81
83
```
82
84
83
-
#### Dans nuxt 3
85
+
#####Dans nuxt 3
84
86
85
87
La bibliothèque VueDsfr fournit bien plusieurs build (esm et umd entre autres) et Nuxt3 sait lequel choisir.
86
88
@@ -140,21 +142,21 @@ const app = createApp(App)
140
142
.mount('#app')
141
143
```
142
144
143
-
## Utiliser les icônes officielles
145
+
###Utiliser les icônes officielles
144
146
145
147
Pour utiliser les icônes officielles, désormais, il n’y a plus d’actions en plus à faire,
146
148
puisque c’est le CSS officiel du DSFR qui est utilisé.
147
149
148
-
## Ajouter des icônes
150
+
###Ajouter des icônes
149
151
150
152
Pour ajouter des icônes qui ne sont pas importées dans la bibliothèque, veuillez consulter
### Installation des pré-requis (testé sous Ubuntu 22.04)
40
+
####Installation des pré-requis (testé sous Ubuntu 22.04)
42
41
43
42
Suivez la procédure suivante en lançant les commandes détaillées ci-dessous :
44
43
@@ -84,13 +83,14 @@ node --version
84
83
85
84
Vous devriez voir 18.x.x
86
85
87
-
## Comment contribuer au projet
86
+
###Comment contribuer au projet
88
87
89
88
- Cloner le projet et créer des [pull-request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
90
89
- Indiquer les bugs dans des [issues](https://github.com/dnum-mi/vue-dsfr/issues)
91
90
- Faire des demandes dans [discussions](https://github.com/dnum-mi/vue-dsfr/discussions)
91
+
- Rejoindre le [server Discord](https://discord.gg/jbBJ9769ZZ)
92
92
93
-
## À propos des pull-requests
93
+
###À propos des pull-requests
94
94
95
95
Les commits doivent suivre la spécification des **[Commits Conventionnels](https://www.conventionalcommits.org/fr/v1.0.0/)** afin que
96
96
l’outil de release automatique détecte les nouvelles fonctionnalités et les corrections d’anomalies.
0 commit comments