Une aide-mémoire Markdown incontournable pour les programmeurs !

Cet article vous apporte des connaissances pertinentes sur Markdown. Le contenu principal est de résumer et de partager avec vous une aide-mémoire Markdown. Les amis intéressés peuvent y jeter un œil ci-dessous.

Markdown est un langage de balisage léger que nous pouvons utiliser pour formater des documents en texte brut.

Chaque référentiel sur GitHub possède son propre fichier README expliquant le but du référentiel. Chaque projet nécessite une bonne documentation. La documentation GitHub est écrite en Markdown. C'est pourquoi il est important de bien maîtriser les bases. Il y a beaucoup d’éléments que vous pouvez écrire dans Markdown, alors examinons-les de plus près.

Paragraphe

En écrivant du texte normal, vous écrivez essentiellement un paragraphe.

Titre

Il existe 6 variantes de titre. Le nombre de symboles "#", et le texte qui suit, indiquent l'importance du titre.

Accentuation

La modification du texte est si simple et si simple. Vous pouvez mettre votre texte en gras, en italique, barré, en surbrillance, en indice ou en exposant.

Citations

Images

Si vous utilisez GitHub, le meilleur moyen est de glisser-déposer les images directement depuis votre ordinateur vers le fichier README. Vous pouvez également créer une référence à l'image et l'attribuer de cette façon. Voici la syntaxe.

Liens

Semblables aux images, les liens peuvent également être insérés directement ou en créant une référence. Peut créer des liens en ligne et bloquer.

Code

Vous pouvez créer des extraits de code en ligne et en bloc complet. Vous pouvez également définir le langage de programmation utilisé dans l'extrait de code. Tout cela se fait en utilisant des barres obliques inverses.

Listes

Tout comme vous pouvez le faire en HTML, Markdown permet la création de listes ordonnées et non ordonnées.

Il est également possible de mélanger les deux listes et de créer des sous-listes.

Vous pouvez également créer des listes de définitions (Termes - Définitions) :

Tableaux

Un excellent moyen d'afficher des données soigneusement organisées. Utilisez les symboles **"|"** pour séparer les colonnes et les symboles ":" pour aligner le contenu des lignes.

Il est également possible de créer un tableau "encombré" en excluant les symboles "|" extérieurs et en ne rendant pas votre code bien structuré.

Listes

Suivez les tâches terminées et les tâches qui doivent être accomplies.

Notes de bas de page

Vous voulez décrire quelque chose à la fin du fichier ? Utilisez les notes de bas de page !

ID du titre

Vous pouvez donner un identifiant à un titre pour accéder directement à cette partie du fichier d'où vous vous trouvez.

Vous pouvez utiliser un astérisque, un trait d'union ou un trait de soulignement (*、-、_) pour créer un tiret. La seule règle est que vous devez inclure un symbole d'au moins trois caractères.

Ici, j'ai créé un repo GitHub, vous pouvez utiliser cette adresse pour vous entraîner :

github.com/im-luka/mar…

Texte original : dev.to/imluka/the-…

Il est impossible de connaître les bugs possibles en temps réel après le déploiement du code. Afin de résoudre ces bugs par la suite, beaucoup de temps a été consacré au débogage des journaux. D'ailleurs, je voudrais recommander une solution utile. Outil de surveillance des BUG Fundebug.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!