Mise en forme du contenu avec Markdown

Dans Namaskar, Il n'y a pas d'interface visuelle WYSIWYG comme celle de Word où l'utilisateur met en forme sa saisie et voit le résultat. Namaskar utilise Markdown comme langage de balisage.

Présentation de Markdown

Markdown est un langage de balisage qui permet de formater du texte en HTML de manière simple et lisible. La syntaxe de Markdown est très intuitive et facile à apprendre.

Les fichiers Markdown sont faciles à lire sous leur forme brute et peuvent être convertis en HTML. Markdown est pris en charge par de nombreux éditeurs de texte, plateformes de blogging et outils de développement. C'est le langage préféré des développeurs pour écrire de la documentation technique comme sur GitHub par exemple.

Markdown étant conçu pour être un langage de balisage simple, la syntaxe Markdown est très intuitive. Voici les éléments de balisage.

Les Titres

Markdown utilise des caractères spéciaux pour indiquer la mise en forme du texte. Pour créer un titre, on utilise le dièse. Il doit absolument être le premier caractère d'une ligne. On le sépare du texte avec une espace. Pour créer des sous-titres de hiérarchie inférieure, il suffit d’insérer des dièses supplémentaires. Comme pour HTML, il y a jusque 6 niveaux de sous-titres.

input
# Ceci est un titre de niveau 1
## Ceci est un titre de niveau 2
### Ceci est un titre de niveau 3
#### Ceci est un titre de niveau 4
output

Ceci est un titre de niveau 1

Ceci est un titre de niveau 2

Ceci est un titre de niveau 3

Ceci est un titre de niveau 4

Pour créer des titres de niveau 1 et de niveau 2, une autre option consiste à utiliser des signes égals et des tirets en les insérant en dessous de la ligne du titre.

input
Ceci est un titre de niveau 1
=================
Ceci est un titre de niveau 2
--------------------------------------
output

Ceci est un titre de niveau 1

Ceci est un titre de niveau 2

Les paragraphes

Pour créer un nouveau paragraphe il suffit d’insérer tout une ligne vierge.

input
# Ceci est un titre de niveau 1

Ceci est un paragraphe.

Ceci est un autre paragraphe.
output

Ceci est un titre de niveau 1

Ceci est un paragraphe.

Ceci est un autre paragraphe.

Gras et italique

Pour écrire en gras et en italique, on utilise les astérisques. Insérez une étoile devant et derrière l’expression le mot ou concerné. Pour le gras, insérez deux étoiles avant et après. Pour le gras et l’italique en même temps, insérez trois étoiles. Une autre option consiste à utiliser les tirets bas (underscore).

input
Ce texte sera *en italique*
Ce texte sera _en italique_
Ce texte sera **en gras**
Ce texte sera __en gras__
Ce texte sera ***en italique et en gras***
Ce texte sera ___en italique et en gras___
output
Ce texte sera en italique
Ce texte sera en italique
Ce texte sera en gras
Ce texte sera en gras
Ce texte sera en italique et en gras
Ce texte sera en italique et en gras

Texte Barré

Pour barrer un texte, précédez-le de deux tildes et refermez la chaîne avec deux autres tildes.

input
par exemple, ~~Ce texte est barré~~ mais pas celui-là.
output
par exemple, ~~Ce texte est barré~~ mais pas celui-là.

Listes

Liste non ordonnée

Pour créer une liste simple, vous avez le choix entre le signe plus, le tiret ou un astérisque. Ces trois options donnent le même rendu.

input
- Objet 1
- Article 2
  - Point 2a
  - Point 2b
output
  • Objet 1
  • Article 2
    • Point 2a
    • Point 2b

Liste ordonnée

Pour créer une liste numérotée, il vous suffira d’inscrire un chiffre suivi d’un point. il n'y a pas besoin de s'occuper de la numérotation, Markdown le fera automatiquement... ce qui est pratique pour réordonner des éléments facilement.

input
1. Point 1
1. Point 2
1. Point 3
  1. Point 3a
  1. Rubrique 3b
output
  1. Point 1
  2. Point 2
  3. Point 3
    1. Point 3a
    2. Rubrique 3b

Les hyperliens

Markdown permet aussi d’insérer des hyperliens . Cette insertion se fait en combinant des parenthèses et des crochets.

input
Voici un lien [Label du lien](https://example.com/ "titre optionnel").

Voici un lien vers [Google](https://www.google.com/).
output
Voici un lien Label du lien.

Voici un lien vers Google.

Il existe d'autres options pour Markdown et Markdown extra... mais les shortcodes que nous allons voir dans le chapitre suivant permettent d'aller beaucoup plus loin dans l'insertion de contenu.