Skip to content

Commit 1cb8763

Browse files
authored
Merge pull request #160 from dnum-mi/docs/vue3-vite-nuxt3-notes
Docs/vue3 vite nuxt3 notes
2 parents 61f239d + 55fbc5c commit 1cb8763

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

src/stories/docs/01-intro.stories.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,12 @@ Ce projet de bibliothèque de composants
4545

4646
# Quels sont les choix techniques retenus
4747

48+
La bibliothèque est faite avec [Vue 3](https://v3.vuejs.org/) et [Vue-router 4](https://next.router.vuejs.org/).
49+
4850
Le JavaScript est linté avec [ESLint](https://eslint.org/) et formatté selon [StandardJS](https://standardjs.org)
4951
avec une seule modification : les virgules
5052
doivent être ajoutées pour tout ce qui est en multiligne (`"comma-dangle": ["error", "always-multiline"]`
51-
cf. [Documentation ESLint]((https://eslint.org/docs/rules/comma-dangle#options)))
53+
cf. [Documentation ESLint]((https://eslint.org/docs/rules/comma-dangle#options))).
5254

5355
Le serveur de développement est celui de [Storybook](https://storybook.js.org/), toute la documentation est faite avec
5456
Storybook, et le site pour tester les composants est le storybook lui-même.

src/stories/docs/02-guide.stories.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Ceci est le guide d̛’utilisation de la bibliothèque. Si vous cherchez à con
99

1010
## Utiliser la bibliothèque en tant que plugin
1111

12+
| Notes : |
13+
|:---------------------------|
14+
| 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/)**. |
15+
| Il est fortement conseillé d’utiliser **[Vite](https://vitejs.dev)** plutôt que Vue-CLI. |
16+
1217
### Installer le plugin
1318

1419
Afin d'installer le plugin taper cette commande dans votre console au sein de votre répertoire de projet :
@@ -17,7 +22,10 @@ Afin d'installer le plugin taper cette commande dans votre console au sein de vo
1722
npm install @laruiss/vue-dsfr@beta
1823
```
1924

20-
*N.B. : Bien indiquer le `@beta` pour avoir la dernière version.
25+
| Note : |
26+
|:---------------------------|
27+
| Bien indiquer le **`@beta`** pour avoir la dernière version. |
28+
2129

2230
### Ajouter le plugin
2331

@@ -31,9 +39,7 @@ const app = createApp(App)
3139
.mount('#app')
3240
```
3341

34-
Ajouter le plugin :
35-
36-
Exemple :
42+
ajouter les lignes commentées :
3743

3844
```js
3945
import { createApp } from 'vue'

0 commit comments

Comments
 (0)