docs: README et documentations développeur et rédacteur

README.md

@@ -1,108 +1,20 @@
 # cartes.gouv.fr-documentation
 
-Site de documentation statique associé à cartes.gouv.fr
+Site de documentation statique associé à [cartes.gouv.fr](https://cartes.gouv.fr/) et aux services de la Géoplateforme.
 
-## Fonctionnalités héritées de eleventy-dsfr
+Il est construit sur la base de [codegouvfr/eleventy-dsfr](https://github.com/codegouvfr/eleventy-dsfr).
 
-- **Style** :
-    - DSFR :
-        - Installation et mise à jour automatique via `npm`.
-        - [Voir les composants déjà implémentés](_includes/components)
-    - [Voir les mises en pages déjà implémentées](_includes/layouts)
-- **a11y et responsivity** : Respecte les recommandations du DSFR.
-- **i18n** : Prise en charge de l'internationalisation des textes et contenus via plusieurs filtres et le [système d'i18n d'Eleventy](https://www.11ty.dev/docs/i18n/).
-- **Navigation** : Utilise le [système de navigation d'Eleventy](https://www.11ty.dev/docs/plugins/navigation/) et gère la navigation de second niveau.
-- **Syntaxe markdown** : Améliorée via l'ajout de [conteneurs personnalisés](./markdown-custom-containers.js).
-- **Images** : Utilise l'[utilitaire d'image d'Eleventy](https://www.11ty.dev/docs/plugins/image/) pour traiter les images (par défaut pour certains composants, par exemple le composant [`card.njk`](_includes/components/card.njk)).
-- **Recherche** : Utilise [pagefind](https://pagefind.app/) pour la recherche.
-- **Pagination** : Utilise le [système de pagination d'Eleventy](https://www.11ty.dev/docs/pagination/) et gère la pagination de second niveau.
-- **Flux RSS** : Utilise le [plugin RSS d'Eleventy](https://www.11ty.dev/docs/plugins/rss/).
-- **Calendrier** : Utilise la bibliothèque [ics](https://www.npmjs.com/package/ics) pour générer un calendrier [`calendar.ics`](https://codegouvfr.github.io/eleventy-dsfr/calendar.ics) à la racine du site, ainsi que les événements `.ics` associés, à partir d'événements.
-- **Mesure d'audience** : Intègre la solution [matomo](public/js/matomo.js).
-- **Pages déjà générées** :
-    - Pages d'accueil, À propos, section Blog (en français et en anglais).
-    - Flux RSS pour Atom et JSON
-    - Plan du site et `sitemap.xml`
-    - Page non trouvée (404)
-    - Les pages obligatoires liées aux obligations légales : “accessibilité : non/partiellement/totalement conforme”, mentions légales, données personnelles et gestion des cookies.
-
-## Prise en main
-
-### Installation
-
-**Cloner le dépôt** :
-
-```bash
-git clone https://github.com/IGNF/cartes.gouv.fr-documentation
-```
-
-**Naviguer dans le dossier** :
-
-```bash
-cd cartes.gouv.fr-documentation
-```
-
-**Installer les dépendances** :
-
-```bash
-npm install
-```
-
-**Exécuter Eleventy** :
-
-Construire un livrable, indexé avec pagefind pour la recherche :
 
-```bash
-npm run build
-```
-
-L'exécuter sur le serveur de développement local :
-
-```bash
-npm start
-```
-
-Ou exécuter un [mode de débogage](https://www.11ty.dev/docs/debugging/).
-
-### Réutilisation
-
-- Modifier les fichiers [`_data/metadata.js`](_data/metadata.js) et [`_data/data.js`](_data/data.js) pour renseigner les informations du site.
-- Modifier le fichier [`package.json`](package.json) pour modifier les informations du dépôt.
-- Compléter les pages obligatoires : [`content/fr/accessibility`](content/fr/accessibility/index.md), [`content/fr/personal-data`](content/fr/personal-data/index.md), [`content/fr/legal`](content/fr/legal/index.md).
-
-### Développement
-
-- Modifier le fichier [`eleventy.config.js`](eleventy.config.js) pour configurer les paramètres d'Eleventy différemment.
-- Ajouter des composants du DSFR dans le dossier [`_includes/components`](_includes/components) et des [mises en page](https://www.11ty.dev/docs/layouts/) dans le
-  dossier [`_includes/layouts`](_includes/layouts).
-    - Ajouter de nouveaux conteneurs markdown dans le fichier [`markdown-custom-containers.js`](markdown-custom-containers.js).
-
-_[Voir aussi la documentation des composants](https://codegouvfr.github.io/eleventy-dsfr/fr/blog/tags/composant/)_
-
-- Ajouter des chaînes de caractères localisées dans le dossier `_data/i18n/[lang]/index.js`.
-    - Pour ajouter une nouvelle traduction, ajouter un dossier `[lang]` dans [`content`](content), un nouveau fichier `_data/i18n/[lang]/index.js` et l'inclure dans [`_data/i18n/index.js`](_data/i18n/index.js).
-- Ajouter des styles personnalisés et des images dans le dossier [`public`](public).
-    - Celui-ci sera copié tel quel dans le dossier de sortie. Cela signifie que `./public/css/*` persistera dans `./_site/css/*` après la construction du livrable.
-- Compléter le [README](README.md) et la [documentation](content/fr/blog/posts). 😀
+## Prise en main
 
-### Ajout de contenu
+[Documentation développeur](docs/developpeur.md)
 
-_[Voir la documentation des fonctionnalités et du Markdown](https://codegouvfr.github.io/eleventy-dsfr/fr/blog/tags/contenu/)_
 
-### Déploiement
+## Ajout de contenu
 
-- Voir un [exemple de worklow de déploiement sur GitHub Pages](https://github.com/codegouvfr/eleventy-dsfr/blob/gh-pages/.github/workflows/11ty-gh-pages.yml) sur la branche `gh-pages`.
+[Documentation rédacteur](docs/redacteur.md)
 
-En cas d'erreur lors du build :
-```bash
-Error: Get Pages site failed
-Error: HttpError: Not Found
-```
-Essayer [cette configuration](https://stackoverflow.com/a/73967433).
-- _[OPTIONNEL]_ [Configurer la redirection](https://www.11ty.dev/docs/i18n/#distinct-urls-using-implied-default-language)
-  de toutes les URLs des pages dont la langue est celle par défaut.
 
 ## Licence
 
-Le dépôt est publié sous licence MIT pour le code et sous licence
-Etalab 2.0 pour les autres contenus.
+Le dépôt est publié sous licence MIT pour le code et sous licence Etalab 2.0 pour les autres contenus.

docs/developpeur.md

@@ -0,0 +1,65 @@
+# Documentation développeur
+
+## Installation
+
+**Cloner le dépôt** :
+
+```bash
+git clone https://github.com/IGNF/cartes.gouv.fr-documentation
+```
+
+**Naviguer dans le dossier** :
+
+```bash
+cd cartes.gouv.fr-documentation
+```
+
+**Installer les dépendances** :
+
+```bash
+npm install
+```
+
+**Exécuter Eleventy** :
+
+Construire un livrable, indexé avec pagefind pour la recherche :
+
+```bash
+npm run build
+```
+
+L'exécuter sur le serveur de développement local :
+
+```bash
+npm start
+```
+
+Ou exécuter un [mode de débogage](https://www.11ty.dev/docs/debugging/).
+
+## Développement
+
+- Modifier le fichier [`eleventy.config.js`](eleventy.config.js) pour configurer les paramètres d'Eleventy différemment.
+- Ajouter des composants du DSFR dans le dossier [`_includes/components`](_includes/components) et des [mises en page](https://www.11ty.dev/docs/layouts/) dans le
+  dossier [`_includes/layouts`](_includes/layouts).
+    - Ajouter de nouveaux conteneurs markdown dans le fichier [`markdown-custom-containers.js`](markdown-custom-containers.js).
+
+_[Voir aussi la documentation des composants](https://codegouvfr.github.io/eleventy-dsfr/fr/blog/tags/composant/)_
+
+- Ajouter des chaînes de caractères localisées dans le dossier `_data/i18n/[lang]/index.js`.
+    - Pour ajouter une nouvelle traduction, ajouter un dossier `[lang]` dans [`content`](content), un nouveau fichier `_data/i18n/[lang]/index.js` et l'inclure dans [`_data/i18n/index.js`](_data/i18n/index.js).
+- Ajouter des styles personnalisés et des images dans le dossier [`public`](public).
+    - Celui-ci sera copié tel quel dans le dossier de sortie. Cela signifie que `./public/css/*` persistera dans `./_site/css/*` après la construction du livrable.
+- Compléter le [README](README.md) et la [documentation](content/fr/blog/posts). 😀
+
+## Déploiement
+
+- Voir un [exemple de worklow de déploiement sur GitHub Pages](https://github.com/codegouvfr/eleventy-dsfr/blob/gh-pages/.github/workflows/11ty-gh-pages.yml) sur la branche `gh-pages`.
+
+En cas d'erreur lors du build :
+```bash
+Error: Get Pages site failed
+Error: HttpError: Not Found
+```
+Essayer [cette configuration](https://stackoverflow.com/a/73967433).
+- _[OPTIONNEL]_ [Configurer la redirection](https://www.11ty.dev/docs/i18n/#distinct-urls-using-implied-default-language)
+  de toutes les URLs des pages dont la langue est celle par défaut.

docs/redacteur.md

@@ -0,0 +1,112 @@
+# Documentation rédacteur
+
+## Structure
+
+Tout le contenu du site se trouve dans le répertoire `content`. En tant que rédacteur, aucune modification n'est généralement nécessaire dans d'autres répertoires.
+
+Le contenu de la barre de navigation principale n'est pas directement déterminée par l'arborescence des dossiers et fichiers mais par le contenu des cartouches de chaque fichier.
+Il est toutefois conseillé d'avoir une arborescence qui correspond à cette navigation pour faciliter le repérage.
+
+Documentation : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/navigation/
+
+La mise en page avec un menu de navigation latéral n'est pas encore implémentée.
+
+## Syntaxe Markdown
+
+Référence : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/md-cheatsheet/
+
+## Composants
+
+Les composants provenant de `codegouvfr/eleventy-dsfr` sont documentés avec des exemples directement sur le site de démonstration https://codegouvfr.github.io/eleventy-dsfr/
+
+Les composants ajoutés pour les besoins de la documentation de cartes.gouv.fr sont expliqués plus en détail ci-dessous.
+
+### Accordéon
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/accordeon/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/accordeon/
+
+### Alerte
+
+```md
+{% from "components/component.njk" import component with context %}
+{{ component("alert", {
+    type: "info",
+    title: "Titre de l'info",
+    description: "<p>Le contenu de l'alerte</p>"
+}) }}
+```
+Si le type est omis, l'alerte sera de type `info`.
+
+Si le title est absent, il s'agira d'une alerte de petite taille, plus discrète.
+
+Les alertes ne peuvent pas avoir de bouton de fermeture.
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/alerte
+
+### Carte
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/carte/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/carte
+
+### Citation
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/citation/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/citation
+
+### Evènement
+
+_Cette possibilité de eleventy-dsfr n'est pas utilisée._
+
+### Fil d'ariane
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/fil-d-ariane/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/fil-d-ariane
+
+### Mise en avant
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/mise-en-avant/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/mise-en-avant
+
+### Onglets
+
+_(à venir)_
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/onglet
+
+### Retour en haut de page
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/retour-en-haut-de-page/
+
+### Schéma
+
+Il est possible d'ajouter des illustrations raster (png, jpeg) ou vecteur (svg) ou d'utiliser la syntaxe `mermaid` pour insérer des schémas.
+
+NB : Le cartouche du fichier doit contenir : `mermaid: true` pour que le js de mermaid qui effectue la transformation du schéma en SVG soit inclus avec la page.
+
+````md
+```mermaid
+flowchart LR
+A[Hard] -->|Text| B(Round)
+B --> C{Decision}
+C -->|One| D[Result 1]
+C -->|Two| E[Result 2]
+```
+````
+
+### Tableau
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/tableau/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/tableau
+
+### Tuile
+
+Exemple : https://codegouvfr.github.io/eleventy-dsfr/fr/blog/tuile/
+
+Référence : https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/tuile