Merge pull request #160 from dnum-mi/docs/vue3-vite-nuxt3-notes

Docs/vue3 vite nuxt3 notes
dnum-mi · Nov 30, 2021 · 1cb8763 · 1cb8763
2 parents 61f239d + 55fbc5c
commit 1cb8763
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/src/stories/docs/01-intro.stories.mdx b/src/stories/docs/01-intro.stories.mdx
@@ -45,10 +45,12 @@ Ce projet de bibliothèque de composants
 
 # Quels sont les choix techniques retenus
 
+La bibliothèque est faite avec [Vue 3](https://v3.vuejs.org/) et [Vue-router 4](https://next.router.vuejs.org/).
+
 Le JavaScript est linté avec [ESLint](https://eslint.org/) et formatté selon [StandardJS](https://standardjs.org)
 avec une seule modification : les virgules
 doivent être ajoutées pour tout ce qui est en multiligne (`"comma-dangle": ["error", "always-multiline"]`
-cf. [Documentation ESLint]((https://eslint.org/docs/rules/comma-dangle#options)))
+cf. [Documentation ESLint]((https://eslint.org/docs/rules/comma-dangle#options))).
 
 Le serveur de développement est celui de [Storybook](https://storybook.js.org/), toute la documentation est faite avec
 Storybook, et le site pour tester les composants est le storybook lui-même.

diff --git a/src/stories/docs/02-guide.stories.mdx b/src/stories/docs/02-guide.stories.mdx
@@ -9,6 +9,11 @@ Ceci est le guide d̛’utilisation de la bibliothèque. Si vous cherchez à con
 
 ## Utiliser la bibliothèque en tant que plugin
 
+| Notes : |
+|:---------------------------|
+| 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/)**. |
+| Il est fortement conseillé d’utiliser **[Vite](https://vitejs.dev)** plutôt que Vue-CLI. |
+
 ### Installer le plugin
 
 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
 npm install @laruiss/vue-dsfr@beta
 ```
 
-*N.B. : Bien indiquer le `@beta` pour avoir la dernière version.
+| Note : |
+|:---------------------------|
+| Bien indiquer le **`@beta`** pour avoir la dernière version. |
+
 
 ### Ajouter le plugin
 
@@ -31,9 +39,7 @@ const app = createApp(App)
  .mount('#app')
 ```
 
-Ajouter le plugin :
-
-Exemple :
+ajouter les lignes commentées :
 
 ```js
 import { createApp } from 'vue'