Skoali | Documentation

Ceci est un répértoire pour proposer des documentations Pour mettre des images, merci de suivre l'aide en bas du fichier.

Ajouter une documentation

Si vous voulez ajouter une documentation créez un fichier en .md avec la date devant le nom (Ex : 2022-01-01-nom-de-la-doc.md) dans le répertoire /_posts/catégorie en utilisant le style Markdown (Voir aide ci-dessous.) puis faites une pull request.

Proposer une modification

Si jamais vous voulez proposer une modification, modifiez le fichier de la documentation et faites une pull request.

Aide Markdown :

Titres

# : Grand titre
## : Titre moyen
### : Petit titre

Les # sont à placer avant le titre !

Exemples :

Grand titre

Titre moyen

Petit titre

---

Gras et italique

Placez * avant et après la phrase pour la rendre italique
Placez ** avant et après la phrase pour la mettre en gras
Placez *** avant et après la phrase pour la rendre italique et en gras.

Exemple : Voici un mot en **gras** et un en *italique* un en ***italique et en gras***.

Ce qui donne : Voici un mot en gras et un en italique un en italique et en gras.

Barre de séparation

Vous pouvez faire des barres de séparations en faisait :

-----------------

Ce qui donne :

---

Citations :

Vous pouvez faire une citation en mettant > avant de ce que vous voulez citer.

Exemple :
> Ceci est une citation

Ce qui donne :

Ceci est une citation

Bloc de code :

Vous pouvez faire des blocs de code en mettant ``` avant et après le code.

Exemple :

Ceci est un bloc de code

Vous pouvez aussi mettre du code dans une ligne avec ` entre le code.

Exemple :
Voici un `code` dans une ligne

Ce qui donne :

Voici un code dans une ligne

Listes à puces :

Vous pouvez faire des listes à puces en mettant * avant de chaque ligne.

Exemple :
* Phrase 1
* Phrase 2
* Phrase 3

Ce qui donne :

• Phrase 1
• Phrase 2
• Phrase 3

Vous pouvez aussi le faire avec des nombres :

Exemple :
1. Phrase 1
2. Phrase 2
3. Phrase 3

Ce qui donne :

1. Phrase 1
2. Phrase 2
3. Phrase 3

Liens :

Vous pouvez mettre des liens en faisant :

Lien vers [Google](https://google.com).

Ce qui donne : Lien vers Google.

Si vous ne souhaitez pas mettre de texte sur le lien, vous pouvez faire :

<https://google.com>

Ce qui donne : https://google.com

Images :

![Nom de l'image](https://www.google.com/logos/doodles/2019/madeleine-bres-177th-birthday-6448018655019008-l.png)

Ce qui donne :

Pour en mettre dans les documentations mettez l'image dans le dossier /images du répertoire GitHub et à la place du lien mettez : /images/nom.png

Correction des fautes

Le site https://www.corrector.co/fr/ peut aider à trouver les fautes d'orthographe ou de frappe dans l'article que vous avez rédigé.