Github Markdown Cheatheet
La marque standard
Markdown est une norme développée par John Gruber. L'objectif principal avec Markdown est de rendre le fichier possible à lire même en texte pur. Si vous voulez regarder dans un éditeur de texte uniquement, vous devriez passer un bon moment à le lire. Ceci est très utile pour les utilisateurs de VIM et similaire. Remarque, et n'oubliez pas qu'il s'agit d'une norme pour modifier les fichiers texte. Il ne remplace pas HTML. Au lieu de cela, vous l'utilisez pour créer HTML où il est utile. Dans le cas de GitHub, ils formateront le fichier ReadMe sur le site. Tant que vous suivez la norme, vous pouvez vous sentir certain qu'il aura l'air bien.
Puisque Github n'a ajouté que quelques extensions, vous devriez commencer par utiliser une feuille de triche de Markdown et partir de là. Voici une liste des plus courantes.
| Réduction | Extensions | Résultat |
| # (1 par niveau) | Rubriques | |
| * | Italique | |
| ** | Gras | |
| > | Blocsquote | |
| 1. (etc.) | Liste commandée | |
| - | Liste non ordonnée | |
| 'code' | Votre code | |
| "" | Md-ext | Démarrez et terminez un bloc de code |
| - | La règle horizontale | |
| [Description] (https: // www.exemple.com) | Un nom sur carré et URL dans des crochets réguliers | |
| ![Texte alt] (image.png) | Idem, lien vers une image | |
| [1] | Md-ext | Une note de bas de page |
Les listes peuvent être imbriquées en indant tous les articles que vous souhaitez avoir imbriqué.
Autres extensions sur le banc régulier, vous avez les extensions de blocs de code ci-dessus. Ils ne sont pas toujours soutenus par les services.
| Réduction | Extensions | Résultat |
| ### Heading # Custom-ID | Md-ext | Une rubrique que vous pouvez aborder par son identifiant |
| Terme: Définition | Md-ext | Une liste de termes avec des définitions |
| ~ Texte erroné ~ | Md-ext | Texte de strikethrough |
| - [x] tâche à faire | Md-ext | Une liste de tâches que vous pouvez cocher |
Le tableau est très simple, mais vous avez besoin de plusieurs lignes pour le montrer: Tableau:
| Nom | Valeur || ----------- | ---------- |
| Tapis | 100 |
Extensions de github.
GitHub a ajouté quelques extensions pour simplifier les liens vers d'autres personnes et projets. Certains d'entre eux sont les tables mentionnées précédemment. Celui qui vous aidera le plus est l'extension de liaison automatique. Il crée un lien seul lorsque vous l'utilisez sur github.
D'autres sont des tables et des éléments de liste de tâches. Ceux-ci sont pratiques pour garder une trace de vos tâches dans les projets. Le dernier à mentionner est l'extension HTML brute interdite. À l'aide de cette extension, certaines balises sont filtrées lors du rendu pour HTML. Ces balises peuvent provoquer des effets étranges lors du rendu à Github.
Façons d'explorer la marque GitHub
Si vous le trouvez déroutant, vous pouvez également aller sur la page GitHub et utiliser l'éditeur intégré. Lorsque vous l'utilisez, il complète automatiquement certaines fonctions. Cela ne fonctionne que pour les problèmes, mais vous pouvez l'utiliser pour comprendre certaines choses, les emojis sortent comme une liste lorsque vous tapez un côlon (:).
Vous pouvez également trouver un projet sur GitHub qui a un grand fichier ReadMe et le cloner vers votre lecteur local. De là, vous pouvez explorer le fichier à l'aide de tout éditeur que vous souhaitez. Pour les grands éditeurs, Emacs et VIM, il y a un support pour Markdown à travers des extensions.
Si vous utilisez VIM, vous pouvez mettre une extension de mise en évidence de syntaxe de GitHub, VIM-Markdown. Cette extension vous montre que vous avez fait le code correctement. Pour vous aider à voir à quoi cela ressemble, vous pouvez également obtenir l'extension de marque en direct. Avec cela, vous pouvez avoir un serveur Web en cours d'exécution, montrant le résultat en direct lorsque vous tapez.
Avec EMACS, vous avez un mode impatient, un mode en baisse en direct et un temps réel. Ils montrent tous votre page résultante dans un navigateur pendant que vous tapez. Le premier nécessite moins de bibliothèques que ce dernier mais a besoin d'un code de code supplémentaire pour s'exécuter.
Conclusion
Même si Markdown est une petite spécification délibérément simple, il peut être un peu déroutant de commencer avec. La meilleure façon d'apprendre est d'utiliser une feuille de triche et d'écrire votre document Markdown. Vous pouvez mettre à jour votre lecture.MD sur GitHub, et vous pouvez obtenir beaucoup de support des fonctions intégrées de vos éditeurs. En tant que note latérale, Github prend également en charge les emojis que vous pouvez ajouter à votre document. Vous pouvez utiliser la feuille de triche pour trouver celles qu'ils sont.
Télécharger Markdown-Cheatsheethere