La simplicité de rédaction s'appelle Markdown

Si vous aussi vous en avez ras-le-bol de vous prendre la tête avec la mise en forme de documents, alors Markdown est fait pour vous.

Markdown c'est quoi ?

Markdown est un langage de balisage léger facile à lire et à écrire. Il peut être publié tel quel ou être mis en forme grâce à de nombreux outils. C'est d'ailleurs ces outils de mise en forme qui en font sa puissance. Il est possible de faire des sites web, des livres, des rapports, des présentations, ... Personnelement je l'utilise au quotidien :

  • pour créer des blogs avec Pelican (celui-ci en l'occurence)
  • dans les Wikis
  • pour rédiger les fichiers README documentant des projets
  • via Pandoc pour générer divers formats (PDF, Slides de présentation, HTML, ...)
  • sur GitHub, GitLab et autre forges ...

La syntaxe en veux-tu en voilà !

Les titres

# Titre de niveau 1
## Titre de niveau 2
### Titre de niveau 3
###### ... Jusqu'à 6 niveaux

Les phrases, sauts de ligne et paragraphes

Une phrase. Deux phrases.
Un retour à la ligne.
Un autre retour à la ligne. Puis un paragraphe qui se termine par deux espaces ou plus ainsi qu'un retour chariot.  

Un deuxième paragraphe.  

Les mises en emphase

emphase simple : _généralement en italique_
emphase forte : __généralement en gras__

Les citations

> ma citation
>
> > ma citation de citation
>
> retour à la citation "de premier niveau"

Le code source

Du ``code source`` au sein d'une ligne. Puis un bloque de code source :  

    echo "précéder de 4 espaces ou 1 tabulation chaque ligne"

Les listes

Liste non ordonnée :  

  - element un
  - element deux

Liste ordonnée :  

  1. element un
  2. element deux

Les liens, notes de bas de page et les insertions d'images

Un lien hypertexte :

[mon blog](http://mikael-flora.fr).

Une autre solution pour accéder à [mon blog][1].

[1]: http://mikael-flora.fr

Une note de bas de page :

CQFD[^1].

[^1]: Ce Qu'il Fallait Démontrer

Une insertion d'image :

![mon image](/path/monImage.jpg "titre optionnel")

L'autre solution ![mon image][1].

[1]: /url/monImage.jpg "titre optionnel"

Extended Mardown

Markdown c'est bien, mais j'ai une préférence pour quelques fonctionnalités supplémentaires présente dans les versions étendue. En voici quelques une :

  • bloque de code source en spécifiant le langage utilisé (utile pour la coloration syntaxique) :
```bash
echo "mon code source bash"
```
  • les tableaux avec les alignements :
| title 1 | title 2 | title 3 |
| :--- | :---: | ---: |
| align left | align center | align right |

Pourquoi je m'embête à présenter Markdown ?

Je ne sais pas vraiment. J'étais motivé parce que j'adore ce langage peut-être ? Ou alors il va y avoir une tonne d'articles qui vont suivre pour présenter des outils qui l'utilise ? Allez savoir ...

Sources

la syntaxe Markdown

By @Mikael FLORA in
Tags : #documentation,