Introduction à Markdown

Introduction à Markdown

Réduction

Markdown est un outil de conversion de texte à HTML. Aujourd'hui, il est devenu le synonyme de facto d'une classe de langues de description de balisage léger. Il utilise une syntaxe de formatage de texte brut. L'idée derrière Markdown était de rendre la rédaction de pages Web et surtout les entrées de blog aussi simples que la rédaction d'un e-mail. Au moment de novembre 2017, l'objectif est atteint et Markdown ainsi que ses dérivations asciidoc, asciidoctor et asciidoctor-pdf sont largement utilisés.

Markdown se concentre uniquement sur le texte brut et s'abstient de toutes les autres complexités que dans HTML. Il est facile à apprendre car il est resté simple, donc également plus rapidement à mesure que des caractères minimaux sont utilisés, ce qui conduit à moins de chances d'erreur à la fin également. Voir la figure 1 pour un document de base illustré dans l'éditeur de Markdown StackEdit. Sur le côté gauche, vous voyez le code source et sur le côté droit la sortie HTML correspondante. Vous remarquerez peut-être que les titres sont simplement marqués d'un certain nombre de # selon le niveau de hiérarchie du titre.

Conversion de texte

Le texte brut est convertible en XHTML (HTML) et de nombreux autres formats utilisant les outils de ligne de commande comme Markdown ou Pandoc. Fondamentalement, les deux outils ne créent que des fragments HTML et écrivent la sortie sur stdout. Pandoc propose le commutateur «-o nom de fichier» pour écrire la sortie HTML dans le fichier donné. Comme on le voit ci-dessous, le fichier de sortie est nommé Basic.HTML et contient le fragment HTML - deux titres et un paragraphe.

$ pandoc -o basique.HTML BASIC.Maryland
$ Cat Basic.html

Création du package Debian Howto


Préface


Être responsable d'une machine signifie prendre soin du matériel ainsi que des composants logiciels. Comme le montre la vie quotidienne en tant qu'administrateur système, il vaut mieux installer des logiciels en tant que logiciel plutôt que comme un tas de fichiers source. Cela réduit les coûts pour maintenir correctement le système.
$

Pour créer des documents HTML autonomes avec un en-tête HTML complet, Pandoc accepte le commutateur «-s» comme suit:

$ pandoc -o basique.HTML -S BASIC.Maryland
$ Cat Basic.html










Création du package Debian Howto


Préface


Être responsable d'une machine signifie prendre soin du matériel ainsi que des composants logiciels. Comme le montre la vie quotidienne en tant qu'administrateur système, il vaut mieux installer des logiciels en tant que logiciel plutôt que comme un tas de fichiers source. Cela réduit les coûts pour maintenir correctement le système.

L'avantage de garder le contenu séparé de votre affichage visuel est qu'il ne gâchera pas l'apparence de votre site. Version 1.0.1, qui a été développé par John Gruber et Aaron Swartz a été publié en décembre 2004 et est disponible en logiciel libre (voir Liens à la fin de cet article).

Éléments de texte

Titres

Selon le niveau HTML correspondant, les titres sont écrits avec un certain nombre de # comme suit:

# H1
## H2
### H3
#### H4
##### H5
###### H6

Pour H1 et H2, deux autres façons d'écrire sont acceptées:

H1
==
H2
--

Veuillez noter que le nombre de signes ou de tirets égaux doit correspondre au nombre de caractères du titre.

Mettre l'accent sur le texte

Afin de souligner le texte, ces éléments sont pris en charge:

  • italique: astérisques uniques ou soulignements simples
    --
    * IMPORTANT * ET _ AUSSI-IMPORTANT_
    --
  • Texte en gras: double astérisk ou doubles soulignements
    --
    ** IMPORTANT ** et __SO AUTORME__
    --
  • Texte réduit: Double Tildes
    --
    ~~ Texte ~~
    --

Listes

Markdown prend en charge les listes non ordonnées et commandées. Les listes commandées commencent par un astérisque, un plus ou un signe moins. Les listes commandées commencent avec un chiffre. Pour créer des sublilistes, listez le listItem par deux espaces (Markdown, empilEdit) ou quatre espaces (Pandoc) comme vous le voyez ci-dessous:

1. des fruits
* pomme
* banane
2. breuvages
+ eau
+ lait

Images

Le moyen le plus simple est d'utiliser le style en ligne comme suit:

![Le logo Debian] (Debian-Logo.PNG «Debian Logo»)

Cela affiche l'image référencée. Dès que vous déplacez le pointeur de la souris sur l'image, vous voyez le texte de description correspondant.

Code et syntaxe en surbrillance

Il existe deux variantes - code en ligne et blocs de code. Le code en ligne est encadré en trois backtincs comme «» imprimé («Bonjour, monde!")" '. Les blocs de code commencent également et se terminent avec trois backticks mais sur des lignes séparées comme suit:

"
Imprimer («Bonjour, monde!»)
"

Markdown ne prend pas en charge la mise en évidence de la syntaxe, mais les dialectes comme Markdown ici font.

les tables

Markdown ne prend pas en charge les tableaux mais des extensions comme GFM et Markdown ici font.

Blocquotes

Blockquotes commence juste par un signe ">". Il devient tout à fait pratique de citer du texte.

> "Oh! Il est absurde d'avoir une règle de grande et rapide sur ce que l'on devrait
> Lire et ce que l'on ne devrait pas. Plus de la moitié de la culture moderne dépend
> Sur ce que l'on ne devrait pas lire."
>
> L'importance d'être sérieux. (Oscar Wilde)

Liens

Les liens se réfèrent à d'autres documents ou aux sections de la présente. Le style d'écriture est similaire aux images et se compose de la description du lien entre crochets et l'URL entre parenthèses régulières.

[Je suis un lien de style en ligne] (https: // linuxhint.com)

De plus, vous pouvez ajouter un texte alternatif:

[Je suis un lien de style en ligne avec un texte supplémentaire] (https: // linuxhint.com «Linuxhint»)

Les liens peuvent être référencés comme suit:

[Linuxhint] [1]

Du texte

[1]: https: // linuxhint.com

Cela vous permet de créer facilement des listes de références à la fin de votre document car il est courant dans les documents scientifiques.

Conclusion

Markdown est assez simple et incontournable pour tous ceux qui font de la documentation et publie régulièrement du contenu. C'est un grand plaisir de l'utiliser.

Les références

  • EmpilEdit, https: // empilEdit.Io
  • Pandoc, http: // pandoc.org /
  • Markdown, https: // daringfireball.Net / Projets / Markdown /
  • Markdown Cheatheet, https: // github.com / adam-p / markdown-here / wiki / markdown-cheatheet