Tutoriel de Markdown - De la configuration à la syntaxe
En même temps, Markdown est très léger et flexible également. Le cas d'utilisation le plus populaire pour Markdown est pour les fichiers de licence et de lecture dans un référentiel GitHub, mais il est également intégré à de plus en plus de CMS pour gérer les articles de blog, et même à rédiger des articles de recherche. Vous pouvez rendre des équations mathématiques avec des plugins pour letex.
Il est cependant principalement utilisé par les développeurs. Il est vraiment utile pour faire des tutoriels et une documentation grâce à la mise en évidence de la syntaxe pour plusieurs langues et une prise en charge des images et même des GIF.
Commençons par une configuration qui nous permet de prévisualiser le document rendu avec un fichier texte brut Markdown.
ATOM Text Editor et Markdown Aperçu
Vous pouvez télécharger et installer ATOM Text Editor ou Visual Studio Code à suivre. ATOM et VS Code ont tous deux des plugins préinstallés pour Markdown Aperçu. Ici, l'atome sera utilisé mais la syntaxe restera à peu près la même, quel que soit l'éditeur de texte que vous utilisez.
Sur Atom, assurez-vous que le package d'aperçu de Markdown est activé (il est en fait activé par défaut). Créez un dossier pour ce didacticiel Markdown et, là-bas, ouvrez un nouveau fichier (Ctrl + N) et entrez le texte suivant là-dedans.
# C'est un titre___
## C'est aussi un titre
Voici du texte
Enregistrer le fichier (CRTL + S) avec un .extension MD. Par exemple, vous pouvez nommer votre fichier comme test.MD et le .La pièce MD dira à Atom qu'il s'agit d'un fichier de démarque et que l'extension fonctionnerait avec elle comme prévu. Vous pouvez générer un aperçu en utilisant la réduction de clé suivante (CTRL + Shift + M) qui est montrée dans un nouveau volet à côté du fichier texte brut.
Vous pouvez fermer le volet d'aperçu en utilisant la même liaison à la clé ou en utilisant l'interface graphique elle-même.
Avec tout l'installation, nous pouvons regarder de plus près la syntaxe et commencer à créer des documents incroyables à la volée.
Syntaxe Markdown
Comme mentionné précédemment, la principale motivation derrière Markdown est la lisibilité. Cela signifie pas de balises obscures ou de balises imbriquées ou toute autre confusion inductive des chaînes. Au lieu de cela, nous pouvons commencer avec un symbole '#' pour indiquer que cette ligne particulière est un titre.
# Est un titre.## indique également le cap, mais avec une taille de police plus petite.
### Vous pouvez passer à des tailles consécutivement plus petites
Breaks de ligne
Markdown continue de regrouper tout le texte en un seul paragraphe géant même lorsque le texte brut est divisé en plusieurs lignes différentes. Pour atténuer cela, vous pouvez utiliser deux espaces à la fin d'une ligne, puis mettre un caractère Newline (c'est-à-dire ) ou simplement utiliser deux caractères de nouvelle ligne pour un effet légèrement différent comme indiqué ci-dessous.
La phrase «c'est pourquoi…» a commencé dans une nouvelle ligne mais n'est pas espacée de la ligne précédente, tandis que l'utilisation de deux nouvelles nouvelles a créé une séparation plus large.
La règle horizontale
La règle horizontale, comme son nom l'indique, crée une ligne horizontale qui vous permet de structurer votre document et de faire des séparations logiques. Il existe deux méthodes pour créer une règle horizontale. Le premier consiste à utiliser trois soulignements ou plus pour créer une règle horizontale.
#Heading 1___
Le paragraphe et la rubrique sont séparés par une règle horizontale.
___
Une autre section séparée
Une autre option (que je ne recommanderai pas) consiste à utiliser trois tirets ou plus '-' mais ils sont également utilisés pour indiquer que la phrase immédiatement au-dessus d'eux est une rubrique. Donc, si vous n'avez pas de nouvelle ligne entre une phrase et la règle horizontale en dessous, cette phrase prendra la forme d'un titre.
Italique, audacieux et à coupure
La syntaxe pour les trois d'entre elles est assez simple et parle de lui-même.
** C'est en gras **__Ce est également audacieux__
_Ci est italique_
* C'est aussi italique *
~~ c'est un strikethrough ~~
Caractère d'échappement
Maintenant, on pourrait demander, comment écririez-vous littéralement ** du texte ** dans le fichier final Markdown si cela change pour cela en gras à chaque fois. C'est quelque chose que la plupart des langages de programmation traitent également et la solution est similaire à celles - utilisez un personnage de barre. Cela fonctionne également pour d'autres éléments de syntaxe, et n'est pas spécifiquement pour le style audacieux.
\ ** ce n'est plus audacieux \ **Si vous souhaitez afficher le personnage de barre Va-Bombres-choses, alors utilisez deux et ainsi de suite.
\\ se présente comme une seule barre oblique
Blockquotes et blocs de code
Blockquotes et les blocs de code sont beaucoup plus faciles. Un Blockquote peut être utilisé pour mettre en évidence un point important vers lequel vous souhaitez attirer l'attention des lecteurs. Cela peut être réalisé en utilisant un support angulaire droit au début comme indiqué.
# En-tête 1Lorem ipsum Dolor Sit Amet, Consectetur adipiscing elit, sed do eiusmod tempory incididunt ut
Labore et Dolore Magna Aliqua. Ut enim ad minim veiam, quis nostrud exercice ullamco labis
nisi ut aliquip ex ea Commodo consécutif. Duis aute irure Dolor en repreahance en voluptate
Velit Esse Cillum Dolore eu fugiat nulla pariatur. Excepteur sint occaecat CupiDatat non
PROFIENT, SUNT À CULPA QUI OFFICIA DESERUNT MOLLIT ANIM ID EST LABOLUM.
> Ceci est un résumé soigné d'une sous-section de votre document. Un> couple de lignes qui se tiennent
du reste du contenu.
Le contenu continue.
Voici à quoi ça ressemble quand il est rendu.
Pour les blocs de code, lisez simplement les lignes les lignes de 4 espaces ou plus. C'est vraiment
pratique pour les développeurs et les opérateurs qui souhaitent documenter leur travail. Nous verrions plus tard comment rendre cela encore meilleur.
Hyperliens et images
Pour les hyperliens, la syntaxe est assez simple. Le texte visible est écrit entre crochets et l'URL à laquelle il pointe est écrit entre crochets juste à côté.
Pour les images, la syntaxe est similaire, sauf qu'elle commence par une marque d'exclamation. Vous êtes libre d'utiliser un chemin relatif dans votre dossier de projet qui pointe vers l'image ou vous pouvez avoir une URL publique.
## illustrant l'hyperlien et la syntaxe d'image___
Vous devriez [nous rendre visite] (https: // linuxhint.com) plus souvent
C'est ainsi que les images sont intégrées.
![Smugpug] (https: // télécharger.wikimedia.org / wikipedia / commons / d / d2 / bonny_bonita.Jpg)
les tables
La création de tables dans Markdown comprend littéralement un portrait ASCII (Unicode pour être précis) d'un tableau.
## Les tables| Colonne 1 | Colonne 2 | Colonne 3 |
| --------- | --------- | --------- |
| Première rangée | Première rangée | Première rangée |
| Deuxième rangée | Deuxième rangée | Deuxième rangée |
La syntaxe n'a pas besoin d'être exactement alignée d'une ligne à une autre, mais le caractère de tuyau est utilisé pour passer à la colonne suivante et la ligne suivante indique que la ligne suivante a commencé, généralement.
Marquage prolongé
Pour ceux d'entre vous qui sont venus si loin, voici le vrai régal. Si vous utilisez Atom, vous pouvez réellement remplacer le plugin d'aperçu de Markdown pour Markdown Aperçu Plus. Qui offre les fonctionnalités suivantes.
1. Équations mathématiques utilisant le latex:
Vous pouvez réellement insérer des scripts en latex entre les signes du dollar et il sera rendu sous forme de script de latex et illustré dans l'aperçu avec CTRL + merdique + x Keybinding. Vous n'avez même pas besoin de connaître tout le latex, juste quelques extraits suffisent.
## illustrant le latex___
$$ | \ psi \ Hangle = \ alpha | 0 \ Hangle + \ Beta | \ Hangle $$
2. Syntaxe mise en évidence
Au lieu d'utiliser l'indentation pour indiquer des blocs de code, vous pouvez réellement utiliser des backticks suivis du nom des langues dans lesquelles votre script est censé être écrit. Les langues dont la syntaxe sont prises en charge sont trop nombreuses à énumérer ici, mais voici un exemple dans Python.
## illustrant la mise en évidence de la syntaxe___
"python
importer ceci
def my_function ():
Print ("Bonjour, monde!")
retour 0
"
Il y a beaucoup de saveurs ou de marque. Github a sa propre infusion spéciale et la syntaxe est très flexible. Ce n'est pas censé intimider les utilisateurs, mais pour en prendre une plus grande variété. C'est l'une de ces langues que l'on comprend simplement un sous-ensemble dont on a besoin et l'utilise, au lieu de se déranger par les détails techniques (à moins que vous ne soyez intéressé par ses détails techniques!)