Exercice 16 - Revue de code documentée

Mise en situation

Vous avez compris le pourquoi et la raison d'être de Vitepress, maintenant il est temps de le mettre en pratique avec un exercice pratique!

Modalités

• Exercice en équipe de deux
• Réaliser durant le cours
• Durée approximative le reste du cours
• Remettre le tout sur Léa dans Exercice 16 pour le prochain cours.

À faire (étapes)

Exercice formatif noté. Une absence de 2h peut être notée si l'exercice n'est pas remis.

Étape 0

• Prenez le temps de lire la documentation de revue de code suivante
• Faite l'installation d'une documentation Vitepress nommée exer16
  • Nom de la documentation: Exercice 16
  • Description: Revue de code documentée
• Faire npm run docs:dev pour lancer la documentation

Étape 1

Dans index.md

• Ajoutez clairement vos deux noms affichés sur cette page
• Faites un ménage de cette page pour enlever les éléments superflus (exemple liens sociaux)
• Modifiez le fichier pour pointer vers deux articles:
  • prenom1-nom1.md (première personne) =>à la place de api-examples.md
  • prenom2-nom2.md (deuxième personne) =>à la place de markdown-examples.md

Dans les deux autres pages

• Modifier chaque fichier avec une documentation de revue de code. Inspirez-vous de la documentation de revue de code.
• Vous devez faire la revue de code du TP01 final de l'autre personne.
• N'oubliez pas les bonnes pratiques
• Répondez aux questions suivantes:
  • Le code
  • Pas les tests pour l'instant
  • Autres
• Vos pages doivent contenir les éléments Markdown suivants:
  • Des titres qui séparent les éléments
  • Des hyperliens qui pointent vers des sources
  • Des gras ou italique sur les éléments importants.
  • Des listes pour des éléments sous formats de liste
  • De l'affichage de code au besoin
    • Allez voir la documentation!

Dans .vitepress/config.mts

• Aller voir le contenu de ce fichier
• Faites certaines modifications pour que ça cadre avec votre documentation

Étape 2

• Je vous recommande de mettre le fichier dézippé. gitignore suivant à la racine de votre projet.
  Ça va permettre de ne pas git add certains dossiers comme node_modules!
  gitignore.zip

IMPORTANT
La méthode est différente du déploiement avec Vue. Faire les ajustements suivants:

• Le repo doit avoir le nom suivant: appweb-exer16
• Le fichier deploy.yml ne sera pas le même que pour vue! Prendre celui-ci.
• Si vous avez installé votre doc à la racine (pas dans un dossier docs), vous devez aussi modifier deploy.yml:
  • path: docs/.vitepress/dist => path: .vitepress/dist
• Vous devez changer le base path pour que ça coïncide avec celui sur GitHub Page comme expliqué ici. C'est dans le fichier .vitepress/config.mts
  • Vous écrivez, après le title et la description: base: '/appweb-exer16/',
• Le reste des étapes sont les mêmes que sur la procédure du cours 11:
  • Déployer votre documentation sur GitHub Page comme fait lors du cours de déploiement
    => Atelier 08
• Si tout s'est bien passé, vous devriez voir votre documentation en ligne comme ici:
  • https://jimmygilbert.github.io/appweb-exer16/

Remise

• Sur Léa dans Exercice 16 pour la date prévue
• Pour les deux personnes:
  • Me remettre le lien vers votre documentation en ligne sur GitHub Page