Aller au contenu principal

Markdown

I love Markdown

Aujourd'hui, nous allons plonger dans le monde fascinant du language Markdown.

📌 Pourquoi maitriser le Markdown ?

Maîtriser le Markdown, c'est détenir la clé d'une communication claire et efficace dans le monde de l'informatique moderne :

  • GitHub, où les README.md sont essentiels pour la documentation de projets
  • Discord, où les discussions peuvent être plus claires avec ce langage
  • Slack et Trello l'utilisent pour formater les tâches et les commentaires
  • ...

Le Markdown permet de structurer rapidement et avec élégance vos messages, vos notes et vos documents, rendant l'information accessible et agréable à lire.

Ainsi votre travail collaboratif est non seulement plus productif mais aussi plus professionnel.

astuce

Le Markdown est aussi un outil fabuleux pour rédiger une documentation agréable à lire et facile à mettre à jour.

Notions théoriques​

Markdown est un langage de balisage léger qui permet de formater du texte en utilisant des symboles simples.

Les titres​

Pour créer des titres, on utilise le symbole #.

Plus vous mettez de #, plus votre titre est petit.

# Titre niveau 1
## Titre niveau 2
### Titre niveau 3
#### Titre niveau 4
##### Titre niveau 5
###### Titre niveau 6

Les paragraphes​

Pour écrire un paragraphe, vous tapez simplement votre texte.

Pour un saut de ligne, vous appuyez sur "Entrée" 2 fois.

Voici un paragraphe, il contient plein de mots et c'est tout.

Et voilà un autre paragraphe après un saut de ligne.

La mise en forme du texte​

Vous voulez que votre texte ait de la force ?

Utilisez **texte** pour le gras ou *texte* pour l'italique.

*italique*
**gras**
***gras italique***
astuce

On peut aussi utiliser le caractère _ (underscore) à la place de l'étoile *

_italique_
__gras__
___gras italique___
📌 Résultat

italique gras gras italique

Les listes​

Vous avez les listes non ordonnées avec des * ou des -, et les listes ordonnées avec des chiffres.

- Élément 1
- Élément 2
- Élément 3

1. Premier
2. Deuxième
3. Troisième

Les liens​

Pour insérer un lien, vous mettez le texte du lien entre [] et l'URL entre ().

[Texte du lien](http://url-du-lien.com)

Les images​

Pour ajouter une image, c'est presque pareil que pour un lien, mais vous rajoutez un ! devant.

![Texte alternatif](url-de-l-image.jpg)

Les blocs de code​

Si vous voulez montrer un bout de code, entourez-le avec 3 backticks ```.

astuce

Pour saisir un backtick:

  • il suffit de taper la combinaison de touches : Alt-gr + 7 puis n'importe quelle autre touche.
'''
ls -la
cd /home/sio
ls -la
'''
'''html
<html>
 <head>
  <title>
   Exemple de HTML
  </title>
 </head>
 <body>
  Ceci est une phrase avec un <a href="cible.html">hyperlien</a>.
  <p>
   Ceci est un paragraphe où il n’y a pas d’hyperlien.
  </p>
 </body>
</html>
'''

Les citations​

Pour citer quelqu'un, il suffit d'utiliser le caractère >

> Ceci est une citation.

Exemple pratique​

Créer un README.md

Maintenant, on va créer un fichier README.md pour documenter une configuration réseau.

# Configuration réseau de mon serveur Debian

## Introduction

Bienvenue sur la documentation de mon réseau. Ici, vous trouverez toutes les infos nécessaires pour comprendre ma configuration.

## Détails de la configuration

Voici les étapes que j'ai suivies pour configurer mon réseau :

1. Mise à jour du système
2. Installation des outils réseau
3. Configuration de la carte réseau 
4. Test de la connectivité

### Mise à jour du système

Pour commencer, mettez à jour votre système avec la commande suivante :

'''
sudo  update && sudo  upgrade
'''

### Installation des outils réseau

Installez les outils nécessaires :

'''
sudo  install net-tools
'''

### Configuration de la carte réseau

Voici un exemple de configuration pour `/etc/network/interfaces` :

'''
auto eth0
iface eth0 inet static
address 172.16.138.10
netmask 255.255.0.0
gateway 172.16.138.250
'''

### Test de la connectivité

Testez votre connexion avec `ping` :

'''
ping -c 4 google.com
'''

Test de mémorisation/compréhension​


Pour créer un titre de niveau 3 en Markdown, quel symbole utilise-t-on ?


Quelle syntaxe permet de créer un lien hypertexte ?


Comment fait-on pour insérer une image en Markdown ?


Quelle est la syntaxe correcte pour mettre du texte en gras ?


Comment écrit-on une liste ordonnée en Markdown ?


TP pour créer une documentation​

Votre mission consiste à créer un README.md pour documenter l'installation d'un serveur Web avec Apache.

astuce

Pour gérer les versions de cette documentation, il est conseillé de créer un dépôt Git.

Vous devrez inclure :

  • Un titre principal et plusieurs sous-titres
  • Des explications sur la configuration d'Apache
  • Les commandes à exécuter pour installer Apache
  • Une liste des étapes à suivre
  • Un lien vers une ressource externe
  • Et en bonus, une image qui représente une configuration réseau

Une fois que vous avez terminé, comparez votre travail avec la solution ci-dessous.

📌 Une solution