comment écrire un readme.md dossier? (markdown fichier)
Dans cet article, vous pouvez apprendre ce qu’est un fichier markdown et comment écrire le fichier markdown. La plupart du temps, vous pouvez trouver ce fichier dans le dépôt distant.
Qu’est-ce que readme.md dossier?
c’est un simple fichier texte qui contient les informations de base des fichiers et quelques guides. Il est utilisé pour écrire un guide d’installation ou une documentation de base dans le répertoire du projet. Les fournisseurs de dépôts les plus populaires comme GitHub, gitlab et bitbucket utilisent readme.md fichier en tant que descripteur de fichier.
qu’est-ce que le markdown?,
Markdown est un langage de script qui est très léger. Il est utilisé pour formater le texte brut à un design respectif. Les démarques sont rapidement utilisées dans la rédaction de contenu dans certains sites Web de blog. Il convertit du texte brut au format souhaité en HTML. La simplicité et facile à comprendre rend le markdown plus populaire. Il prend tout le texte du fichier markdown et le convertit en HTML via une application markdown ou un compilateur.,
Si vous êtes un débutant à démarque de fichier, alors cet article est fait pour vous. Je vais écrire un readme.md fichier afin que vous ayez une meilleure compréhension du script markdown.
ici, j’utilise visual studio code ID pour écrire un fichier markdown. Vous trouverez ci-dessous les étapes pour créer un fichier markdown dans visual studio code.,
Étape 1: Ouvrir le code de visual studio et goto file > new file
Étape 2: indiquez le Nom du fichier readme.md ou readme.markdown et enregistrez le fichier.
Étape-3: Recherchez et cliquez sur l’icône‘open preview to the side’.
Étape 4: Commencez à écrire le script.
Titres
Pour l’écriture des titres, vous devez ajouter le symbole # au début de la ligne., Le numéro du symbole de hachage augmentera le type de titre changera en fonction de cela.
Vous pouvez écrire jusqu’à la Rubrique 6.
texte Normal
Si vous voulez écrire un texte normal puis écrire un texte simple ici, pas besoin d’ajouter des balises, il sera automatiquement convertie en texte.,
liens hypertexte
Vous pouvez ajouter un lien hypertexte dans un fichier markdown en utilisant le dessous de la balise.
(targetURL)
ex: (https://www.github.com)
Vous pouvez également écrire un titre du lien (Tout en survolant le lien, le titre s’affiche)
(targetURL "Link title")
par exemple,,div id= »fb7de34b3f »>
remarque: assurez-vous un espace unique qui devrait être leur entre targetURL et titre)
Solide et texte en italique
Vous pouvez écrire forte et en italique texte en ajoutant des traits de soulignement _ avant et à la fin de la ligne, pour le texte en italique ajouter étoile double ** avant et à la fin de la ligne pour fort/texte en gras.,
_Italic text here_
Barré
Si vous voulez la grève par le biais d’un mot ou d’une ligne, puis ajouter deux symbole tilde au début et à la fin de la ligne.,
~~Strikethrough text~~
Images
You can add images in a markdown file by using the below tag.
!(TargetUrl)
Tables
You can write a table by using the below format of text.,
Quotes
If you want to write quotes the just add a > symbol at the beginning of the line.
>Your quote looks like this.
Code
You can write code by appending ` symbol at the beginning and end of the line.,
bloc de Code
Si vous voulez écrire un bloc de code, puis d’ajouter « au début et de fin du code.
Vous pouvez spécifier votre langue après le « au début de la ligne.,
```Language
your code
```
Liste
Vous pouvez écrire une liste ordonnée, la liste non ordonnée, et mixtes liste. Veuillez consulter le format ci-dessous pour écrire une liste., »e15c8b1bd4″>
Horizontal line
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.,
