Comment travailler avec GitHub Flavored Markdown sous Linux
Markdown est un langage de formatage créé pour le Web. Le but de Markdown est de faciliter la vie lorsque nous écrivons sur Internet. Au fil du temps, de nombreuses variantes de démarque ont été créées. Mais dans cet article, nous nous concentrerons principalement sur Github Flavored Markdown (GFM).
Github est basé sur CommonMark. Il existe de nombreuses fonctionnalités supplémentaires prises en charge dans GFM, telles que les tables, la clôture de code, etc. Entrons dans le vif du sujet et explorons la syntaxe de GFM et comment l’utiliser dans différents cas.
J’utilise VScode pour le démontrer, mais vous pouvez choisir n’importe quel éditeur Linux qui vous convient. Certains éditeurs comme Atom et Vscode prennent en charge Markdown et pour certains éditeurs, nous devons installer un plugin Markdown.
Pour travailler avec Markdown, le fichier doit être enregistré avec .md ou .markdown comme extension.
Comment ajouter des titres à l’éditeur Markdown
Il y a 6 niveaux de titre pris en charge dans le markdown. Pour créer un titre, utilisez le symbole dièse (#) suivi d’un espace et du nom du titre. Plus la valeur de hachage est élevée, plus la taille de l’en-tête est basse.
REMARQUE : par défaut pour H1 et H2, le style est souligné.
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading 6
Parfois, vous voudrez peut-être aligner le cap vers le centre. Mais la triste histoire est que l’alignement n’est pas pris en charge par défaut dans Markdown. Par défaut, les titres sont affichés avec un alignement à gauche. Vous pouvez intégrer des balises HTML/CSS dans Markdown pour obtenir un alignement.
<h1 style="text-align:center">MARKDOWN</h1>
<h1 style="text-align:left">MARKDOWN</h1>
<h1 style="text-align:right">MARKDOWN</h1>
<h1 style="text-align:justify">MARKDOWN</h1>
Comment ajouter des commentaires à l’éditeur Markdown
Les commentaires sont un moyen de documenter certaines choses pour une meilleure compréhension du code/des documents. Cela ne sera pas rendu par le moteur markdown.
<!--
Comment block
-->
Comment rendre du texte sur une seule ligne
Normalement, lorsque vous tapez quelque chose sur des lignes séparées l’une après l’autre, Markdown le rendra sur une seule ligne.
Vous pouvez créer des sauts de ligne de deux manières.
- Saut de ligne doux
- Rupture dure
Des sauts de ligne doux peuvent être créés en ajoutant deux espaces à la fin de la ligne. De cette façon, Markdown rendra chaque ligne comme étant des lignes distinctes.
Les ruptures de ligne dure peuvent être créées en insérant une ligne vide entre chaque ligne.
Comment ajouter des lignes horizontales
La règle horizontale peut être créée en plaçant au moins trois astérisques (*), traits d’union(-) ou traits de soulignement (_) sur une seule ligne. Il est également possible d’ajouter de l’espace entre eux.
* * *
---
___
Comment mettre un texte en gras
Pour mettre un mot ou des lignes en gras, entourez-les entre des astérisques doubles (**) ou des traits de soulignement doubles (__).
**Making this sentence bold using double asterisks.**
__Making this sentence bold using double underscore.__
Comment faire un texte en italique
Pour mettre des mots ou des lignes en italique, entourez-les d’astérisques simples (*) ou de traits de soulignement simples (_).
*Making this line to be italicized using asterisks.*
_Making this line to be italicized using underscore._
Comment ajouter un barré aux lignes
Pour frapper quoi que ce soit, vous devez utiliser un double tilde. Entourez tout ce dont vous avez besoin entre les doubles tildes (~~).
I am just striking the word ~~Howdy~~.
~~I am striking off the entire line.~~
Comment ajouter un blockquote
Utilisez Supérieur à un symbole (>) pour les guillemets.
> Single line blockquote.
Voyez comment la citation du bloc ci-dessous est rendue. Les deux lignes sont rendues sur la même ligne.
> first line
> Second line
> Third line
> Fourth line
Vous pouvez utiliser le retour de ligne en laissant deux espaces à la fin de chaque ligne. De cette façon, chaque ligne ne sera pas rendue sur une seule ligne.
Laissez les lignes alternées vides préfixées par un symbole supérieur à un symbole. De cette façon, vous pouvez créer un saut de ligne entre chaque ligne d’un même bloc.
> first line
>
> Second line
>
> Third line
>
> Fourth line
Vous pouvez également créer des guillemets imbriqués en ajoutant deux symboles supérieurs à (>>).
Créer du code en ligne
Utilisez BACKTICK pour créer du code en ligne. L’exemple ci-dessous montre comment créer du code en ligne. Regardez le mot notes et lisez-moi qui a été rendu sous forme de code en ligne.
Markdown is one of the best tools for taking `notes` and creating `readme` files.
Mise en évidence de la syntaxe d’un bloc de code
Ajoutez des tabulations ou 4 espaces et placez votre code pour le rendre sous forme de bloc de code. Vous pouvez également placer votre code entre trois apostrophes inversées pour que le bloc soit rendu en tant que bloc de code. La caractéristique importante à noter ici est la coloration syntaxique. Normalement, lorsque vous placez le code à l’intérieur du bloc, aucun schéma de couleurs ne lui est appliqué.
```
echo "Hello world"
```
Regardez maintenant le même exemple, le schéma de couleurs est appliqué automatiquement. C’est possible en ajoutant le nom du langage de programmation après trois contre-courants, ce qui appliquera le schéma de couleurs au code.
```bash
echo "Hello world"
```
Exemple de code python.
```python
def fp():
print("Hello World!!!")
fp()
```
Exemple de requête SQL.
```sql
SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE
WHERE SALARY_EMP<(SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE)
```
Créer des listes ordonnées et non ordonnées
Les éléments peuvent être organisés en listes ordonnées et en listes non ordonnées en markdown. Pour créer une liste ordonnée, ajoutez des numéros suivis d’un point. Ce qu’il est intéressant de noter ici, c’est que le nombre n’a pas besoin d’être séquentiel. Le moteur Markdown est assez intelligent pour comprendre qu’il s’agit d’une liste ordonnée, même si nous effectuons l’ordre non séquentiel.
Dans l’exemple ci-dessous, vous pouvez voir que j’ai créé une liste ordonnée avec un ordre non séquentiel (10, 15, 150) mais que le moteur Markdown la rend dans l’ordre approprié. Vous pouvez également créer une liste imbriquée, comme illustré dans l’image.
Pour créer une liste non ordonnée, utilisez le signe plus (+), les astérisques (*) ou le tiret (-) suivi d’un espace et du contenu de la liste. Semblable à la liste ordonnée, vous pouvez également créer une liste imbriquée ici.
Créer une liste de tâches
Il s’agit d’une particularité de GFM. Vous pouvez créer une liste de tâches comme indiqué dans l’image ci-dessous. Pour marquer la tâche comme terminée, vous devez ajouter « x » entre accolades carrées, comme indiqué dans l’image.
Ajouter des liens au texte
Pour ajouter un lien, suivez la syntaxe ci-dessous.
[Tecmint](https://linux-console.net "The best site for Linux")
Décomposons la syntaxe en 3 parties.
- Texte à afficher – Il s’agit du texte qui sera placé à l’intérieur des accolades carrées ([Tecmint]).
- Lien – vous placerez le lien réel à l’intérieur de la parenthèse.
- Titre – Lorsque vous passez votre souris sur le texte, une info-bulle s’affiche pour le lien. Le titre doit être placé entre guillemets, comme indiqué dans l’image.
Sur l’image ci-dessous, vous pouvez voir que « Tecmint » est mon texte d’affichage et lorsque je clique, il me redirigera vers « linux-console.net ».
Vous pouvez également créer des liens en les plaçant entre crochets < >.
Ajouter des liens aux images
La syntaxe de l’image ressemble à celle de l’ajout de liens. Pour ajouter une image, suivez la syntaxe ci-dessous.
Décomposons la syntaxe en 3 parties.
- Texte alternatif – Le texte alternatif sera placé entre crochets ( ![ alt-text]). Si une image est cassée ou ne peut pas être chargée, ce texte sera affiché avec un symbole cassé.
- Lien – À l’intérieur des crochets, vous placerez le lien réel vers l’image.
- Titre – Lorsque vous passez votre souris sur l’image, le nom de l’image s’affiche. Le titre doit être placé entre guillemets, comme indiqué dans l’image.
Vous pouvez également créer un lien avec des images. Lorsqu’un utilisateur clique sur l’image, celle-ci est redirigée vers un lien externe. La syntaxe reste la même avec quelques modifications. Entourez la même syntaxe que celle utilisée pour insérer une image entre crochets suivie d’un lien entre parenthèses.
[](https://en.wikipedia.org/wiki/Markdown)
Créer une table
Les tables ne sont pas prises en charge dans la version originale de Markdown. C’est l’une des particularités de GFM. Voyons comment construire une table étape par étape.
La première partie consiste à créer des noms de colonnes. Les noms de colonnes peuvent être créés en les séparant par des barres verticales (|).
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
Sur la deuxième ligne, utilisez des tirets (-) en combinaison avec un deux-points (:). Les tirets indiquent au moteur Markdown qu’il doit être rendu sous forme de tableau et les deux-points décident si notre texte doit être aligné au centre, à gauche ou à droite.
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
|:-------------:|:-------------|------------:|
:---: ⇒ Center alignment
:--- ⇒ Left alignment
---: ⇒ Right alignment
À partir de la troisième ligne, vous pouvez commencer à créer des enregistrements. Les enregistrements doivent être séparés par une barre verticale (|).
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
|:-------------:|:-------------|------------:|
| Ravi | 30 | 127 |
| karthick | 27 | 128 |
Sur l’image ci-dessus, vous pouvez voir que le tableau est rendu correctement. La colonne 1 est alignée au centre, les colonnes 2 et 3 sont alignées à gauche et à droite. Si vous utilisez Vscode, vous pouvez utiliser « Markdown Table Prettif » pour formater proprement la table.
Créer un emoji
GFM prend en charge un large éventail d’emojis. Jetez un coup d’œil à l’aide-mémoire emoji.
C’est tout pour cet article. Si vous avez des commentaires, veuillez les poster dans la section des commentaires.