à faire

• Nettoyage des dossiers 🎉
• Ajout collection 'type projet'
• Faire un index des projets
• Ajout date
• Ajout tags
• Paramétrage connection ssh github
• Créer des dossiers manquants
• Compléter les dossiers existants
• Ajouter des images
• Ajouter header metadonnées dans les .md
• Script pour vérfier que les images sont au bon format
• Ajouter assets css
• Pouvoir ajouter des vidéos
• Ajouter publish true/false
• Caption images

Format des métadonnées du fichier .MD

layout : page
type: projet
title: "mon titre"
author: "prénom nom"
publish: true

Comment documenter ?

Le projet est basé sur le générateur de site statique Eleventy

structure du projet

root/ 
      |
      
      -- eleventy.js       (fichier de configuration)
      -- \_includes        (templates)
      -- assets            (css et js)
      
      -- src/ 
              |
              -- <prenom-nom>/
                              |
                              -- <annee>/
                                          |
                                          -- <titre>/
                                                     |
                                                      -- index.md
                                                      -- <image.jpg>
                

Nom des dossiers et fichiers

pas de caractères spéciaux, espace, accents, etc

Cloner le dépôt

pour le cloner en ssh :

git clone git@github.com:RandomLab/docs.randomlab.io.git

Si le dépôt est déjà cloner

git pull

On renseigne son travail dans un dossier (voir structure) Après avoir fini de documenter, on ajoute les changements dans git en local

git add .
git commit -m "j'ai bien travaillé.e"

On envoir sa copie local au serveur github

git push