Home
CS POK MON Projets

Contribuer

Tags :
  • HOME
  • GUIDE
Auteurs :
  • François Brucker
  • Loïck Goupil-Hallay

Liens utiles

Le site Do_It est entièrement statique et généré par eleventy.
Les pages qui s'affichent sont des fichiers à la base écrit en Markdown pour permettre une écriture simple et rapide.

Ajouter du contenu

Pour ajouter du contenu, il faut d'abord connaître sa promotion (par exemple 2024-2025), et son nom (par exemple Gordon-Zola).

Le directory élève

Le directory élève (dossier élève pour ceux qui viennent de Windows) est le directory qui contient les informations et les publications de l'élève. Il est situé dans le dossier src/promos/2024-2025/Gordon-Zola/.

Pour le créer, vous devez utiliser l'utilitaire node: npm run init-student dans le terminal. Vous allez devoir selectionner la promotion dans laquelle vous voulez ajouter votre directory élève. Ensuite vous devrez rentrer votre nom et prénom.
Cela va automatiquement créer un directory élève ainsi qu'une branche git locale à votre nom dans la promotion choisie, avec tous les fichiers nécessaires pour commencer à écrire.

Structure du directory élève



Zola-Gordon/ (Student directory)
├── index.md (Student index file)
├── assets/ (Student assets directory, contains medias, styles, scripts)
├── mon/
│   ├── index.md
│   ├── temps-X.Y/
│   │   ├── assets/ (MON assets directory, contains medias, styles, scripts)
│   │   ├── index.md (MANDATORY if markdown files are present)
│   │   ├── other_file.md (OPTIONAL)
│   │   ├── subdirectory/ (OPTIONAL)
│   │   │   ├── ...
│   ├── ...
├── pok/
│   ├── index.md
│   ├── temps-X/
│   │   ├── assets/ (POK assets directory, contains medias, styles, scripts)
│   │   ├── index.md (MANDATORY if markdown files are present)
│   │   ├── other_file.md (OPTIONAL)
│   │   ├── subdirectory/ (OPTIONAL)
│   │   │   ├── ...
│   ├── ...

Attention

Si vous avez déjà un directory élève, n'allez pas en créer un autre. Vous pouvez directement ajouter des fichiers dans votre directory élève existant.

Ajouter un POK

Pour ajouter / éditer un POK, il suffit d'aller éditer le fichier src/promos/VOTRE_PROMOTION/VOTRE_DIRECTORY_ELEVE/pok/temps-TEMPS/index.md.

Il faut seulement s'assurer que le fichier contient son entête avec:

Le reste du fichier est en markdown, vous êtes libre d'écrire ce que vous voulez.

Exemple d'entête POK



---
layout: layout/pok.njk

title: TITRE_DE_VOTRE_POK

date: DATE_DE_PUBLICATION

temps: TEMPS_DU_POK (1,2,3)

authors:
  - VOTRE_APPELLATION

tags:
  - VOS_TAGS

description: RÉSUMÉ_DE_VOTRE_POK
---

Ajouter un MON

Pour ajouter / éditer un MON, il suffit d'aller éditer le fichier src/promos/VOTRE_PROMOTION/VOTRE_DIRECTORY_ELEVE/mon/temps-TEMPS/index.md.

Il faut seulement s'assurer que le fichier contient son entête avec:

Le reste du fichier est en markdown, vous êtes libre d'écrire ce que vous voulez.

Exemple d'entête MON



---
layout: layout/mon.njk

title: TITRE_DE_VOTRE_MON

date: DATE_DE_PUBLICATION

temps: TEMPS_DU_MON (1,2,3)

authors:
  - VOTRE_APPELLATION

tags:
  - VOS_TAGS

description: RÉSUMÉ_DE_VOTRE_MON
---

Ajouter un projet

Pour ajouter / éditer un projet, cela se passe dans src/promos/VOTRE_PROMOTION/_projets/VOTRE_PROJET.

Il faut seulement s'assurer que le fichier contient son entête avec:

Le reste du fichier est en markdown, vous êtes libre d'écrire ce que vous voulez.

Exemple d'entête projet



---
layout: layout/projet.njk

title: TITRE_DE_VOTRE_PROJET

date: DATE_DE_PUBLICATION

authors:
  - VOTRE_APPELLATION

tags:
  - VOS_TAGS

description: RÉSUMÉ_DE_VOTRE_PROJET
---

Bonnes pratiques

Pour que le site reste cohérent et lisible, il est recommandé de suivre quelques bonnes pratiques:

Optimiser l'encodage des images

Afin de réduire l'impact des images / vidéos / sons sur le temps de chargement du site, il est recommandé d'optimiser leur encodage.
Pour cela, vous pouvez utiliser des outils tels que ffmpeg, ils permettent de grandement réduire la taille des fichiers sans perte de qualité.

Installer ffmpeg

Réencoder un fichier

Information

  • Réencoder les fichiers permet de réduire leur taille (avec ou sans perte de qualité selon les paramètres)
  • Le gain de taille pour une vidéo est généralement de l'ordre de 90% (50Mo -> 5Mo) par rapport à un encodage rapide par défaut.
  • Le gain de taille pour une image est généralement de l'ordre de 50% (2Mo -> 1Mo) par rapport à un encodage rapide par défaut.

Pour réencoder un fichier avec ffmpeg, il suffit de lancer la commande suivante dans le terminal: ffmpeg -i <fichier_source> -preset veryslow <fichier_destination>

Attention

  • La commande peut être longue à s'exécuter pour des gros fichiers de l'ordre de 100Mo
  • Par défaut, ffmpeg ne peut pas écraser un fichier existant sans le flag -y
  • Il est recommandé d'utiliser le preset veryslow pour une meilleure compression des vidéos

Autres guides