Skip to content

Commit 59e0175

Browse files
committed
docs: 📝 améliore la documentation pour Nuxt 3
1 parent 381f806 commit 59e0175

File tree

1 file changed

+71
-12
lines changed

1 file changed

+71
-12
lines changed

docs/pour-commencer.md

Lines changed: 71 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -373,23 +373,82 @@ const searchQuery = ref('')
373373

374374
### Nuxt3
375375

376-
Dans `nuxt.config.js` :
376+
1. Ajouter les dépendances `@gouvfr/dsfr` et `@gouvminint/vue-dsfr` ainsi que les dépendances de développement `vite` et `vue-dsfr-nuxt-module` au projet
377377

378-
```typescript
378+
```bash
379+
# Avec pnpm
380+
pnpm add @gouvfr/dsfr @gouvminint/vue-dsfr
381+
pnpm add -D vue-dsfr-nuxt-module vite
382+
383+
# Avec yarn
384+
yard add @gouvfr/dsfr @gouvminint/vue-dsfr
385+
yarn add --dev vue-dsfr-nuxt-module vite
386+
387+
# Avec npm
388+
npm i @gouvfr/dsfr @gouvminint/vue-dsfr
389+
npm i -D vue-dsfr-nuxt-module vite
390+
```
391+
392+
2. Ajouter `vue-dsfr-nuxt-module` dans la section `modules` de `nuxt.config.ts`
393+
394+
```ts{3}
395+
export default defineNuxtConfig({
396+
modules: [
397+
'vue-dsfr-nuxt-module'
398+
]
399+
})
400+
```
401+
402+
3. Ajouter le CSS de DSFR dans la section `css` de `nuxt.config.ts`
403+
404+
```ts{5-11}
379405
export default defineNuxtConfig({
406+
modules: [
407+
'vue-dsfr-nuxt-module'
408+
],
380409
css: [
381-
'@gouvfr/dsfr/dist/core/core.main.min.css', // Le CSS du DSFR
382-
'@gouvfr/dsfr/dist/component/component.main.min.css' // Styles de tous les composants du DSFR
383-
'@gouvfr/dsfr/dist/utility/utility.main.min.css' // Classes utilitaires : les composants de VueDsfr en ont besoin
384-
'@gouvminint/vue-dsfr/styles', // Les styles propres aux composants de VueDsfr
410+
'@gouvfr/dsfr/dist/core/core.main.min.css', // Le CSS minimal du DSFR
411+
'@gouvfr/dsfr/dist/component/component.main.min.css', // Styles de tous les composants du DSFR
412+
'@gouvfr/dsfr/dist/utility/utility.main.min.css', // Classes utilitaires : les composants de VueDsfr en ont besoin, contient aussi les icônes
413+
414+
'@gouvfr/dsfr/dist/scheme/scheme.min.css', // Facultatif : Si les thèmes sont utilisés (thème sombre, thème en bernes)
415+
],
416+
})
417+
```
418+
419+
1. Facultatif : ajouter des icônes à utiliser avec OhVueIcon
420+
421+
```ts{1,14-20}
422+
import * as icons from './icons' // Fichier à créer, voir plus loin
385423
386-
'@gouvfr/dsfr/dist/scheme/scheme.min.css' // Facultatif : Si les thèmes sont utilisés (thème sombre, thème en bernes)
387-
'@gouvfr/dsfr/dist/utility/icons/icons.min.css', // Facultatif : Si des icônes sont utilisées avec les classes "fr-icon-..."
424+
export default defineNuxtConfig({
425+
modules: [
426+
'vue-dsfr-nuxt-module'
388427
],
389-
ignore: [
390-
'**/*.test.*',
391-
'**/*.spec.*',
392-
'**/*.cy.*',
428+
css: [
429+
'@gouvfr/dsfr/dist/core/core.main.min.css', // Le CSS minimal du DSFR
430+
'@gouvfr/dsfr/dist/component/component.main.min.css', // Styles de tous les composants du DSFR
431+
'@gouvfr/dsfr/dist/utility/utility.main.min.css', // Classes utilitaires : les composants de VueDsfr en ont besoin, contient aussi les icônes
432+
433+
'@gouvfr/dsfr/dist/scheme/scheme.min.css', // Facultatif : Si les thèmes sont utilisés (thème sombre, thème en bernes)
393434
],
435+
runtimeConfig: {
436+
public: {
437+
vueDsfr: {
438+
icons: Object.values(icons),
439+
},
440+
},
441+
},
394442
})
395443
```
444+
445+
Et ajouter un fichier `icons.ts` à la racine dans lequel sont réexportées depuis `'oh-vue-icons/icons'` les icônes utilisées :
446+
447+
```ts
448+
export {
449+
RiFlagLine,
450+
RiHome2Line,
451+
} from 'oh-vue-icons/icons'
452+
```
453+
454+
Et voilà ! Vous êtes prêts à utiliser VueDsfr dans votre app Nuxt ✨

0 commit comments

Comments
 (0)