Skip to content

[FR] La sacro sainte charte du Wiki

Thorgaran edited this page Jun 17, 2023 · 4 revisions

Comme vous pouvez le voir, le wiki a pour le moment deux version, une version française [FR] et une version anglaise [EN]. Vous pouvez naviguer dans chacune des version grace a la sidebar correspondante.

Pour ajouter une page à la sidebar, il suffit simplement de cliquer sur le crayon en haut à droite de celle-ci (ce qui reviens a modifier le ficher _Sidebar)

Contribuer

Vous avez fait un truc, et vous voulez l'ajouter au wiki ? Pour ce faire vous pouvez créer une nouvelle page ! Le wiki utilise markdown. Voici quelques tips qui vous permettront de gagner du temps 👍

Ajouter une image au wiki

Vous pouvez ajouter une image au wiki en glissant déposant un ficher dans la zone de texte, ainsi github va automatiquement vous générer un fichier qu'il passera sous https://github.com/Etoiles-ing/CCleaner_Project/assests/....

L’inconvénient de cette méthode est que si jamais vous supprimez toutes les références a cette image, celle-ci sera aussi supprimée (ce qui n'est pas très pratique lorsque vous êtes en train de faire de la doc!)

La solution que nous avons trouvé consiste à ajouter les images manuellement au wiki, en les plaçant dans un dossier nommé assets : git clone https://github.com/Etoiles-ing/CCleaner_Project.wiki.git

Ajoutez vos images, faites un commit puis vous pouvez push !

Une fois ceci fait vous pouvez référencer vos images via la syntaxe suivante :

[[/assets/ImageName.png]]

Faire changer l'image en fonction du thème :

Pour faire changer l'image en fonction du thème vous devez utiliser la syntaxe suivante :

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="assets/dark_image.png">
  <source media="(prefers-color-scheme: light)" srcset="assets/light_image.png">
  <img alt="Image description" src="assets/dark_image_OR_light_image.png"> #Correspond à l'image par default si le thème n'est pas détecté 
</picture>