From 1025559d66cf54e741e0dd14f4197cdf6dfd0c77 Mon Sep 17 00:00:00 2001 From: newick Date: Thu, 13 Feb 2025 16:51:51 +0100 Subject: [PATCH] avance la doc --- Contribution.md | 81 ++++++++++++++++++++++++ README.md | 112 +++++---------------------------- content/accessibility/index.md | 4 +- 3 files changed, 97 insertions(+), 100 deletions(-) create mode 100644 Contribution.md diff --git a/Contribution.md b/Contribution.md new file mode 100644 index 000000000..fa5703aff --- /dev/null +++ b/Contribution.md @@ -0,0 +1,81 @@ +# Contribuer + +## Header +### Modifier le contenu de la navigation + + +## Footer + +### Modifier le texte du footer + +Il se trouve dans `_data/data.js`. + +### Modifier les liens +Le contenu se trouve dans `_includes/templates/footer.njk`, c'est du HTML + +### Formations + +Pour qu'une formation n'apparraisse plus dans la page prochaine formation il faut que la date spécifiée entre `---` soit passée. + +## Contenus + +Ils se trouvent dans `content` + +- `a-propos`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/a-propos/ ; +- `accessibility`, il s'agide de la page https://ecoresponsable.numerique.gouv.fr/accessibilite/ ; +- `actualites`, regroupe tous les articles. Pour la gestion voir [la section dédiée](#actualites) ; +- `barometre`, partie cachée actuellement, pour la remettre il faut mettre le code suivant en dessous du permalink + +``` + eleventyNavigation: + key: barometre + title: Baromètre + order: 5 +``` +- `calendar`, n'est plus utilisé pour le moment ; +- `contact`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/contact/ ; +- `declaration-ecoconception`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/declaration-ecoconception/ ; +- `feed`, permet de générer le flus RSS ; +- `financement`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/financement/ ; +- `formations`, contient toutes les sous-pages de la navigation "Formations" ; +- `legal`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/mentions-legales/ ; +- `personal-data`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/donnees-personnelles/ ; +- `publications`, il s'agit des anciens contenus, pour éviter les 404 ; +- `reglementation`, il s'agit de la page https://ecoresponsable.numerique.gouv.fr/reglementation/ ; +- `ressources`, contient toutes les sous-pages de la navigation "Ressources" ; +- `sitemap`, permet de générer le plan du site ; +- `thematiques`, anciens contenus, permet d'éviter les 404. + +### Actualités + +Les différents article se trouvent dans le dossier "posts". + +Les fichiers "index.njk", "tags_index.njk et "tags.njk" servent à l'affichage des contenus. + +#### Créer et ranger les actualités + +Dans le dossier "posts", il y a plusieurs sous-dossiers : + +- `actus`qui accueille les différentes actualités en vrac. Il est possible de faire des dossiers pour s'y retrouver, ça n'impactera pas les urls ; +- `img`, voir la [section](#ajouter-une-image-à-une-actualité) dédiée ; +- `lettres-information` regroupe les articles de newsletter +- `podcasts` regroupe les podcasts +- `videos` regroupe les vidéos +- `vieux` regroupe les articles présents avant la mise à jour, permet surtout d'éviter les 404 + +#### Ajouter une image à une actualité + +Il faut les mettre dans le dossier `img`, de préférence au format `.webp`. + +Une fois qu'elle est créée, il faut vérfier dans le fichier `.md` de l'actualité que l'image est bien appelée pour servir de miniature dans la liste des actus. + +Le code se trouve dans les metas données (entre les `---`) et ressemble à + +``` +image: + path: ../img/monImage.webp + alt: "" +``` +⚠️ le chemin `../img` est le chemin si l'actualité est dans `actus`, `lettres-information`, `podcasts` ou `videos`. Si l'article est dans un sous-dossier il faut remplacer par `../../img`. + + diff --git a/README.md b/README.md index e4e4ebee3..c52379db3 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,14 @@ -[![img](https://img.shields.io/badge/code.gouv.fr-publi%C3%A9-orange.svg)](https://code.gouv.fr/documentation/#/publier) -![build](https://img.shields.io/github/actions/workflow/status/codegouvfr/eleventy-dsfr/11ty-gh-pages.yml?label=deployed%20to%20gh-pages) - -# eleventy-dsfr - -Un dépôt pour démarrer un site statique au [DSFR](https://www.systeme-de-design.gouv.fr/) avec le -générateur [Eleventy](https://www.11ty.dev/), déployé pour démonstration sur [GitHub Pages](https://codegouvfr.github.io/eleventy-dsfr/fr/). -Pour d'autres exemples de réutilisation, cf. [Démonstration et réutilisations](#démonstration-et-réutilisations). - -![Screenshot of the website front page.](eleventy-dsfr.png) - -## Fonctionnalités - -- **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. +# MiNumEco - Mission interministérielle numérique écoresponsable + +Code du site web https://ecoresponsable.numerique.gouv.fr/ + +![MiNumEco - Mission interministérielle numérique écoresponsable](https://ecoresponsable.numerique.gouv.fr/img/logo.webp) + +Le site est développé à partir du repo [Eleventy](https://github.com/codegouvfr/eleventy-dsfr) intégrant le [DSFR](https://www.systeme-de-design.gouv.fr/) + +## Contribuer + +Les informations sont dans [Contribution.md](Contribution.md) ## Prise en main ### Installation @@ -39,13 +16,13 @@ Pour d'autres exemples de réutilisation, cf. [Démonstration et réutilisations **Cloner le dépôt** : ```bash -git clone https://github.com/codegouvfr/eleventy-dsfr.git my-site-name +git clone https://github.com/DISIC/MiNumEco MiNumEco ``` **Naviguer dans le dossier** : ```bash -cd my-site-name +cd MiNumEco ``` **Installer les dépendances** : @@ -70,58 +47,9 @@ 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). 😀 - -### Ajout de contenu - -_[Voir la documentation des fonctionnalités et du Markdown](https://codegouvfr.github.io/eleventy-dsfr/fr/blog/tags/contenu/)_ - ### 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. - -## Documentation - -La suite de la documentation (composants, fonctionnalités) est disponible dans [`content/fr/blog/posts`](content/fr/blog/posts) ou directement sur le [site de démonstration](https://codegouvfr.github.io/eleventy-dsfr/fr/blog). - -## Démonstration et réutilisations - -Pour une démonstration, voir la [GitHub Pages](https://codegouvfr.github.io/eleventy-dsfr/fr/) correspondante. - -- [Site de la mission logiciels libres de la DINUM](https://code.gouv.fr) (code source : https://github.com/codegouvfr/codegouvfr-website). -- [Site du cadre de cohérence technique du MI](https://dnum-mi.github.io/cct-mi/) (code source : https://github.com/dnum-mi/cct-mi) -- [Site de documentation pour cartes.gouv.fr](https://ignf.github.io/cartes.gouv.fr-documentation/) (code source : https://github.com/IGNF/cartes.gouv.fr-documentation) -- [Partie blog du site de DiaLog](https://dialog.beta.gouv.fr/blog/fr/) (code source : https://github.com/MTES-MCT/dialog/tree/main/blog) -- [Site de la start-up Médiation Logement](https://mediationlogement.beta.gouv.fr/) (code source : https://github.com/betagouv/mediation-logement) -- [Portail du BARRI du CISIRH](https://cisirh.github.io/portail-barri/fr/) (code source : https://github.com/CISIRH/portail-barri) +Expliquer la façon de déployer, et les erreurs ## Licence @@ -130,15 +58,3 @@ Etalab 2.0 pour les autres contenus. Il est maintenu par la [mission logiciels libres](https://code.gouv.fr/) de la DINUM. -### Crédits images - -- [1F3DB.svg](public/icons/1F3DB.svg) par [Martin Wehl](https://openmoji.org/library/#author=Martin%20Wehl) sous licence [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0>). - - -## Contribuer - -### Modifier le texte du footer -Il se trouve dans `_data/data.js`. - -### Formations -Pour qu'une formation n'apparraisse plus dans la page prochaine formation il faut que la date spécifiée entre `---` soit passée. diff --git a/content/accessibility/index.md b/content/accessibility/index.md index 1d59d10c5..d0ff479a7 100644 --- a/content/accessibility/index.md +++ b/content/accessibility/index.md @@ -1,7 +1,7 @@ --- -title: Exemple de déclaration d’accessibilité +title: Déclaration d’accessibilité layout: layouts/post.njk -description: Déclaration d’accessibilité à compléter +description: Déclaration d’accessibilité slugOverride: accessibilite showBreadcrumb: true permalink: /accessibilite/