doc: update

cnumr · Dec 1, 2023 · 322b2d1 · 322b2d1
1 parent 9abd816
commit 322b2d1
Show file tree

Hide file tree

Showing 6 changed files with 125 additions and 65 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 ---
 label: Home
 icon: home
-order: 900
+order: 1000
 ---
 
 ![](./ecoindex-intro.png)
@@ -25,11 +25,15 @@ Afin d'obtenir :
 - Des rapports HTML, JSON ou la Déclaration Environnementale de votre site – Environmental Impact Statement (EIS) – de GreenIT.fr®
 - Ajouter ces résultats dans votre CI/CD ou un à serveur Lighthouse.
 
+!!!info Déclaration Environnementale de GreenIT.fr®
+[!button target="blank" icon="checklist" iconAlign="right" text="Découvir"](https://declaration.greenit.fr/)
+!!!
+
 ## Récapitulatif des fonctionnalités
 
-> **cli (int)**: client interne `npx lighthouse-ecoindex <command> <options>` ;  
-> **cli (lh)**: client Lighthouse `npm lighthouse <url> <options>` ;  
-> **CI**: Lighthouse CI
+- [!button size="xs" text="cli (int)"](./guides/1-lighthouse-ecoindex-cli.md) client interne `npx lighthouse-ecoindex <command> <options>` ;  
+- [!button size="xs" text="cli (lh)"](./guides/2-lighthouse-cli.md) client Lighthouse `npm lighthouse <url> <options>` ;  
+- [!button size="xs" text="CI"](./guides/3-lighthouse-ci.md) Lighthouse CI
 
 | Fonctionnalités                                          | cli(int) | cli (lh) | CI  |
 | :------------------------------------------------------- | -------- | -------- | --- |
@@ -40,9 +44,9 @@ Afin d'obtenir :
 
 ## Documentation des usages
 
-[!ref CLI `lighthouse-ecoindex`](/guides/1-lighthouse-ecoindex-cli.md)
-[!ref CLI `lighthouse`](/guides/2-lighthouse-cli.md)
-[!ref `lighthouse-ci`](/guides/3-lighthouse-ci.md)
+[!ref lighthouse-ecoindex CLI](/guides/1-lighthouse-ecoindex-cli.md)
+[!ref Lighthouse CLI](/guides/2-lighthouse-cli.md)
+[!ref Lighthouse CI](/guides/3-lighthouse-ci.md)
 
 ![Details of plugin results](./ecoindex-results.png)
 

diff --git a/docs/bonnes-pratiques/00-index.md b/docs/bonnes-pratiques/00-index.md
@@ -1,10 +1,12 @@
 ---
-Label: Intruductions
+Label: Introductions
 icon: info
 order: 1000
 ---
 
-# Les bonnes pratiques proposées comme audits dans le plugin Ecoindex Lighthouse
+# Les audits du plugin
+
+Les bonnes pratiques proposées comme audits dans le plugin Ecoindex Lighthouse
 
 !!! :zap: Pourquoi toutes les bonnes pratiques ne sont pas présentes ? :zap:
 Pour être ajoutées comme audits, les bonnes pratiques doivent être mesurables et quantifiables.

diff --git a/docs/guides/1-lighthouse-ecoindex-cli.md b/docs/guides/1-lighthouse-ecoindex-cli.md
@@ -21,77 +21,96 @@ A la sortie, vous obtiendrez :
 
 ## Installation
 
-Il n'est pas nécessaire d'installer le plugin `lighthouse-plugin-ecoindex` pour l'utiliser. Il est possible de l'utiliser directement avec `npx` :
-
-```bash
-npx lighthouse-ecoindex <command> <options>
-```
+Il n'est pas nécessaire d'installer le plugin `lighthouse-plugin-ecoindex` pour l'utiliser. Il est possible de l'utiliser directement avec `npx`.
 
 ## Utilisation
 
 ```bash
 npx lighthouse-ecoindex <command> <options>
 ```
 
-**Commandes :**
+Commandes disponibles :
 
 +++ collect
 
-```text
-Run Lighthouse and save the results to a local folder.
-
-Options:
-      --help            Show help                                      [boolean]
-      --version         Show version number                            [boolean]
-  -d, --demo            Use demo URLs.                [boolean] [default: false]
-  -u, --url             URL to process, supports multiple values         [array]
-  -j, --json-file       Structured file, must respect a schema (see documentatio
-                        n).                                             [string]
-  -h, --extra-header    Extra object config for Lighthouse. JSON string or path
-                        to a JSON file.                 [string] [default: null]
-  -p, --output-path     Output folder.           [string] [default: "./reports"]
-  -o, --output          Reporter for the results, supports multiple values. choi
-                        ces: "json", "html", "statement". WARN: "csv" is not ava
-                        lailable with flow.         [string] [default: ["html"]]
-  -a, --audit-category  Audit to run, supports multiple values.
-  [array] [default: ["performance","seo","accessibility","best-practices","light
-                                                        house-plugin-ecoindex"]]
-
-Examples:
-  lighthouse-ecoindex collect --demo        Generates a report for the demo URLs
-                                            .
-  lighthouse-ecoindex collect --json-file   Generates multiples reports for mult
-  ./input-file.json                         iples courses.
-  lighthouse-ecoindex collect --url https:  Generates multiples reports for mult
-  //ecoindex.fr/                            iples courses.
-
-For more information on this Lighthouse Ecoindex script helper, see https://gith
-ub.com/cnumr/lighthouse-plugin-ecoindex#readme
-```
+`npx lighthouse-ecoindex collect <options>`
+
+Sert à lancer la collecte des audits Lighthouse et EcoIndex suivant les options passées en paramètres.
 
 +++ convert
 
-```text
-Convert JSON report(s) generated by `lighthouse-ecoindex` to Environmental State
-ment file.
+`npx lighthouse-ecoindex convert <options>`
+
+Sert à générer la Déclaration Environnementale de votre site – Environmental Impact Statement (EIS) – de GreenIT.fr® au format JSON, HTML et Markdown, si elle n'a pas été générée lors de la collecte.
+
++++
+
+!!!info Déclaration Environnementale de GreenIT.fr®
+[!button target="blank" icon="checklist" iconAlign="right" text="Découvir"](https://declaration.greenit.fr/)
+!!!
+
+### command `collect`
+
+`npx lighthouse-ecoindex collect <options>`
+
+Sert à lancer la collecte des audits Lighthouse et EcoIndex suivant les options passées en paramètres.
+
+#### Options
+
+- `-d, --demo` : Utilise les un fichier de démonstration (voir plus bas).
+- `-u, --url` : URL à auditer, supporte plusieurs valeurs.
+- `-j, --json-file` : Fichier structuré, doit respecter un schéma (voir plus bas).
+- `-h, --extra-header` : Objet de configuration supplémentaire pour Lighthouse. Chaîne JSON ou chemin vers un fichier JSON.
+- `-p, --output-path` : Dossier de sortie.
+- `-o, --output` : Rapporteur pour les résultats, supporte plusieurs valeurs. Choix : "json", "html", "statement". ATTENTION : "csv" n'est pas disponible.
+- `-a, --audit-category` : Audit à exécuter, supporte plusieurs valeurs.
+- `--help` : Affiche l'aide.
 
-Options:
-      --help          Show help                                        [boolean]
-      --version       Show version number                              [boolean]
-  -i, --input-report  JSON file generate by `lighthouse-ecoindex`.       [array]
-  -p, --output-path   Output folder.             [string] [default: "./reports"]
+#### Fichier de configuration JSON
 
-Examples:
-  lighthouse-ecoindex convert --input-repo  Convert JSON report(s) generated by
-  rt ./lh-export-1.json --input-report ./l  `lighthouse-ecoindex` to Environment
-  h-export-2.json                           al Statement file.
+!!!warning
+Le format du fichier doit être respecté !
+!!!
 
-For more information on this Lighthouse Ecoindex script helper, see https://gith
-ub.com/cnumr/lighthouse-plugin-ecoindex#readme
+==- Modèle de fichier JSON
+:::code source="../../lighthouse-plugin-ecoindex/demo/example-input-file.json" :::
+===
+
+<!-- [!file Sample](../../lighthouse-plugin-ecoindex/demo/example-input-file.json) -->
+
+#### Exemples
+
+Génère un rapport avec le fichier de démonstration.
+```shell
+npx lighthouse-ecoindex collect --demo
 ```
 
-+++
+Génère des plusieurs rapports pour de multiples parcours.
+```shell
+npx lighthouse-ecoindex collect --json-file ./input-file.json
+```
+
+Génère un rapport pour une URL.
+```shell
+npx lighthouse-ecoindex collect --url https://ecoindex.fr/
+```
 
-## Options
 
-## Exemples
+### command `convert`
+
+`npx lighthouse-ecoindex convert <options>`
+
+Sert à générer la Déclaration Environnementale de votre site – Environmental Impact Statement (EIS) – de GreenIT.fr® au format JSON, HTML et Markdown, si elle n'a pas été générée lors de la collecte.
+
+#### Options
+
+- `-i, --input-report` : Fichier JSON généré par `lighthouse-ecoindex`.
+- `-p, --output-path` : Dossier de sortie.
+- `--help` : Affiche l'aide.
+
+#### Exemples
+
+Convertir le(s) rapport(s) JSON généré(s) par `lighthouse-ecoindex` en fichier de déclaration environnementale.
+```shell
+npx lighthouse-ecoindex convert --input-report ./lh-export-1.json --input-report ./lh-export-2.json
+```
diff --git a/docs/rapports.md b/docs/rapports.md
@@ -0,0 +1,24 @@
+---
+label: Mesures
+icon: codescan-checkmark
+order: 900
+---
+
+# Que mesure lighthouse-ecoindex ?
+
+Le plugin lighthouse-ecoindex mesure les critères suivants :
+- Le nombres d'élements HTML (DOM) ;
+- Le nombre de requêtes HTTP ;
+- Le poids total des ressources téléchargées.
+
+On peut donc en déduire :
+- Un score EcoIndex®, noté de 0 à 100 ;
+- Une note EcoIndex®, noté de A à E ;
+- Les émissions de CO2 ;
+- La consommation d'eau.
+
+[!ref icon="info" target="blank" text="Comment fonctionne l'écoindex ?"](https://www.ecoindex.fr/comment-ca-marche/)
+
+Ce sont les informations principales que l'on retrouve sur la page de résultat de l'audit.
+
+Vous y retrouverez également un tableau de synthèse des résultats des audits Lighthouse et EcoIndex® : [les audits correspondants aux bonnes pratiques](./bonnes-pratiques/00-index.md).
diff --git a/docs/retype.yml b/docs/retype.yml
@@ -25,12 +25,12 @@ footer:
   copyright: '&copy; Copyright {{ year }}. All rights reserved to GreenIT.fr.'
   links:
     - text: License
-      link: ./license.md
+      link: ./licence.md
       icon: shield
     - text: Association GreenIT.fr
       link: https://asso.greenit.fr/
       target: blank
-      icon: icon-organization
+      icon: organization
 edit:
   repo: 'https://github.com/cnumr/lighthouse-plugin-ecoindex' # The URL to source files for this project
   base: './docs' # Optional base path to a directory within repo

diff --git a/retype.yml b/retype.yml
@@ -0,0 +1,11 @@
+input: .
+output: .retype
+url: # Add your website address here
+branding:
+  title: Project Name
+  label: &1449511052 Docs
+links:
+- text: Docs
+  link: /docs
+footer:
+  copyright: "&copy; Copyright {{ year }}. All rights reserved."