✅ Comment écrire avec Markdown et ses différences avec HTML.

Table des matières

,
, etc, à partir de l'en-tête.
Dans Markdown, c'est très simple, il vous suffit de placer le caractère numérique (#) comme préfixe de l'en-tête, plus il y en a, plus l'en-tête sera de degré inférieur jusqu'à un maximum de 6.
Par exemple un en-tête

Syntaxe triple backtick

Syntaxe de pré-espacement

Qu'est-ce que la démarque
Il est défini autant qu'un logiciel écrit en Parl, qui convertit le texte écrit en HTML et en plus, à la syntaxe utilisée pour atteindre le résultat HTML que nous attendons. Une syntaxe conçue pour être simple pour quiconque veut écrire sur le web, sans avoir besoin de le connaître.
Aujourd'hui, la plupart des gestionnaires de contenu et même de nombreux clients de messagerie prennent en charge l'utilisation de la syntaxe Markdown, nativement, ceci dans le but de faciliter la création de texte formaté sans avoir besoin d'implémenter des styles ou de connaître HTML. . Ces gestionnaires utilisent un analyseur pour convertir le texte Markdown en HTML.
Markdown et documentation
Il est très utile d'apprendre de nombreux outils de documentation à partir de Markdown; wikia, onenote, evernote, alfresco le supportent nativement, ou avec l'aide de tiers. Il est important d'avoir une documentation sur les processus et les problèmes possibles, mais encore plus important est de le garder propre et net même à partir de la console et le markdown est là pour nous aider.
Paragraphes
Si nous écrivions normalement dans un éditeur commun, pour définir un paragraphe, nous appuierons simplement sur quelques touches :

Entrer

Et nous verrons notre curseur passer quelques lignes en dessous pour écrire dans un nouveau paragraphe.
En HTML, on l'appelle
de paragraphe.
Dans Markdown, c'est aussi simple que dans un éditeur normal.
De plus, nous avons l'avantage qu'un seul saut de ligne ne sépare pas le texte en plusieurs lignes, si nous écrivons quelque chose comme ceci :
Un texte. Un autre texte.
Il ressemblera à ceci:
Un texte. Un autre texte.
L'utilisation de plusieurs lignes de séparation réduit également à un seul espace de séparation entre les paragraphes
En-têtes
Dans un éditeur normal, nous aurions besoin de la barre d'outils pour définir un style de titre pour un texte, ou si vous vous sentez un peu désordonné, il suffirait d'augmenter la taille de la police et de la mettre en gras.
En HTML, ils sont appelés
,
, etc, à partir de l'en-tête.
Dans Markdown, c'est très simple, il vous suffit de placer le caractère numérique (#) comme préfixe de l'en-tête, plus il y en a, plus l'en-tête sera de degré inférieur jusqu'à un maximum de 6.
Par exemple un en-tête (le plus grand) et un ils s'écriraient ainsi :
# Gros en-tête ### Petit en-tête
et le résultat sera comme ça.

Grand en-tête
Petit en-tête
Séparateurs
Il n'est normalement pas possible de dessiner des séparateurs dans des éditeurs simples.

AGRANDIR

En HTML, ils deviennent de règles horizontales.
Ils sont délimités en tapant au moins 3 astérisques ou tirets. Ils peuvent être suivis ou séparés par un espace, c'est indifférent.
* * * *** - - - ---
Accent
Cette mise en forme est appelée italique et gras.
En HTML ce serait Oui .
Pour créer du texte au format italique, il suffit d'entourer le texte entre des astérisques simples ou des traits de soulignement, et pour le gras entre des doubles :
* texte en italique. * _ texte en italique._ ** texte en gras. ** __texte en gras .__
Cela ressemblerait à quelque chose comme ceci :
texte en italique. texte en gras.
Barré
Cela permet de placer du texte comme si on le barrait, très utilisé pour le contrôle de version. o Les bogues qui ont été corrigés dans une application ou un système.
EN HTML ce serait barré.
Il suffit d'entourer le texte entre doubles majuscules ou tildes :
~~ texte barré. ~~
Cette option n'est pas standard et peut ne pas fonctionner dans tous les éditeurs.
Devis
Le style de citation n'est généralement pas facile à trouver dans un éditeur de texte commun
En HTML, ce serait
.
Il suffit de placer le caractère "supérieur à" (>) en préfixe du texte qui suit (similaire à l'adressage sous linux)
> Ceci est une citation.
Cela ressemblerait à :

Ceci est une citation.

Listes
Pour définir une liste d'objectifs, nous utilisons généralement la fonctionnalité des puces pour les listes sans ordre spécifique et les listes numérotées.
En HTML ce serait pour les listes non ordonnées, pour les listes ordonnées et pour définir chaque élément de la liste.
Dans Markdown, nous les définissons simplement en préfixant chaque élément avec un astérisque (*), un tiret (-) ou un symbole plus (+) pour les listes non ordonnées. Pour les listes ordonnées, nous préfixons du numéro correspondant et d'un point :
* Rédigez un tutoriel * Publiez-le dans Solvetic. 1. Nouveau tutoriel. 3. Choisissez une section et un niveau. 2. Corrigez les formats et publiez.
Cela ressemblerait à ceci :

Écrire un tutoriel.

Publiez-le sur Solvetic.

Nouveau Tutoriel.

Choisissez une section et un niveau.

Corrigez les formats et publiez.

Dans les listes énumérées la hiérarchie du numéro n'est pas respectée, la position à l'intérieur de celles-ci sera utilisée.
Liens
Placer des liens est extrêmement utile et important car cela vous permet de référencer le contenu vers une documentation externe ou un didacticiel.
Exemple:
Le serveur Nginx a été sécurisé avec fail2ban en utilisant [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)
Nous mettons entre parenthèses [] le texte que l'on veut a le lien puis on le place entre parenthèses () le lien de destination.
Si vous préférez le faire de manière plus ordonnée que d'avoir les références au milieu de votre texte, vous pouvez également le faire de la manière suivante :
Le serveur Nginx a été sécurisé avec fail2ban en utilisant [1]……… [1] : http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx /
Une autre option serait :
Le serveur Nginx a été sécurisé avec fail2ban en utilisant [fail2ban-nginx-solvetic]……… [ssh-nginx-solvetic] : http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo - con-ssh-y-nginx /
Ajoutez maintenant des images.
images
Nous pouvons ajouter des images presque similaires à des liens en ajoutant un ! Avant chacun, je dois souligner de ne pas pouvoir les voir depuis un terminal, enfin pas directement.
! [texte alternatif] (image-url)
Nous pouvons utiliser les mêmes options des liens si nous voulons que cela soit plus organisé.
Planches
Je mets généralement les données d'accès dans des tables de serveurs ou de services.
Pour ce faire, nous traçons les lignes du tableau avec des tubes (|) pour délimiter les colonnes et des tirets (-) pour séparer l'en-tête du reste des lignes :
| Services | Utilisateur | Clé | | ------------- | --------- | ----------- | | FTP |solvétique |aw-D.wak | | SSH | admin |2 -.- am, |
On aurait quelque chose comme ça :

Les tuyaux n'ont pas besoin d'être alignés, et les "bords" sont facultatifs, par exemple :
Rubrique 1 | Titre 2 --- | --- essayons | quelque chose essayons quelques-uns | autre chose. Cela générerait la même table.
Vous pouvez également aligner le texte dans vos colonnes en plaçant le symbole deux-points ( sur le trait d'union fait séparateur du côté que vous souhaitez aligner :
| Aligné à gauche. | Centré | Aligné à droite. | |: ------------------- |: --------: | ----------------- -: | | essai | essai | essai |
Tous les éditeurs n'acceptent pas les tableaux dans Markdown.
Code
On peut surligner notre code avec markdown et il diffère d'une langue à l'autre.
Syntaxe triple backtick

Placer ce type de blocs est très simple, il suffit de joindre le bloc de code que l'on veut saisir.e 3 backticks (`` ``) suivi du nom de la langue à laquelle appartient le code que vous souhaitez placer :
`` `langue x = y …` ``
Un exemple de code JavaScript ressemblerait à ceci :
`` `` test de fonction js () {console.log ('test !')} ''
Cela générerait un joli bloc de code avec une syntaxe mise en évidence pour javascript :
test de fonction () {console.log ('test !')}

Syntaxe de pré-espacement

Une autre façon de placer du texte ou du code préformaté mais sans langue spécifiée consiste à "indenter" notre texte avec 4 espaces, nous l'écririons comme ceci :
x = y // notez qu'il y a 4 espaces entre la marge et ce que nous écrivons.
on aura ce résultat :
x = y // notez qu'il y a 4 espaces entre la marge et ce que nous écrivons.
La norme n'accepte que l'option avec pré-espacement.
ConclusionUn bon système de documentation doit être rapide, flexible et simple. Points que Markdown couvre de très bonne manière, il ne faut pas oublier sa syntaxe propre pour les yeux, quelque chose à prendre en compte si l'on veut revoir la documentation depuis un terminal utilisant VIM/EMACS. L'entrée a une approche pour les administrateurs système mais elle peut être très utile pour tous les types de professionnels ou d'étudiants. J'espère que tout doute ou suggestion a été clair, laissez-le dans les commentaires.Avez-vous aimé et aidé ce tutoriel ?Vous pouvez récompenser l'auteur en appuyant sur ce bouton pour lui donner un point positif