Mastering Markdown (Français)

Markdown est une syntaxe légère et facile à utiliser pour styliser toutes les formes d’écriture sur la plate-forme GitHub.

Ce que vous allez apprendre:

• comment le format Markdown rend l’édition collaborative stylisée facile
• Comment Markdown diffère des approches de formatage traditionnelles
• comment utiliser Markdown pour formater du texte
• Comment tirer parti du rendu de Markdown automatique de GitHub
• Comment appliquer les extensions de Markdown uniques de GitHub

Qu’est-ce que Markdown?

Markdown est un moyen de styliser du texte sur le web., Vous contrôlez l’affichage du document; le formatage des mots en gras ou en italique, l’ajout d’images et la création de listes ne sont que quelques-unes des choses que nous pouvons faire avec Markdown. La plupart du temps, Markdown n’est que du texte régulier avec quelques caractères non alphabétiques, comme # ou *.,

Vous pouvez utiliser Markdown la plupart des endroits autour de GitHub:

• Gist
• Commentaires dans les Questions et les Pull requests
• les Fichiers avec l’ .md ou .markdown extension

Pour plus d’informations, voir « Écrit sur GitHub” dans le GitHub de l’Aide.

Exemples

• Texte
• Liste
• Images
• les en-Têtes & Devis
• Code
• Extras

la Syntaxe guide

Voici un aperçu de la syntaxe Markdown que vous pouvez utiliser n’importe où sur GitHub.com ou dans vos propres fichiers de texte.,3>Headers

# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag

Emphasis

*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_

Lists

Unordered

* Item 1* Item 2 * Item 2a * Item 2b

Ordered

1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b

Images

!(/images/logo.png)Format: !(url)

Links

http://github.com - automatic!(http://github.com)

Blockquotes

As Kanye West said:> We're living the future so> the present is our past.

Inline code

I think you should use an`<addr>` element here instead.

GitHub Flavored Markdown

GitHub.,com utilise sa propre version de la syntaxe Markdown qui fournit un ensemble supplémentaire de fonctionnalités utiles, dont beaucoup facilitent le travail avec le contenu sur GitHub.com.

notez que certaines fonctionnalités de Github Flavored Markdown ne sont disponibles que dans les descriptions et les commentaires des problèmes et des Pull Requests. Ceux-ci incluent les @mentions ainsi que les références aux hachages SHA-1, aux problèmes et aux Pull Requests. Les listes de tâches sont également disponibles dans les commentaires Gist et dans les fichiers Gist Markdown.,

Syntaxe

Voici un exemple de comment vous pouvez utiliser la coloration syntaxique avec GitHub Aromatisé Markdown:

```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```

Vous pouvez aussi tout simplement indenter votre code en quatre espaces:

 function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }

Voici un exemple de code Python sans syntaxe:

def foo(): if not bar: return True

des Listes de Tâches

Si vous incluez une liste de tâches dans le premier commentaire d’un Problème, vous obtiendrez une pratique de l’indicateur de progression dans votre liste de sortie. Cela fonctionne également dans les Pull Requests!,parating chaque colonne avec une pipe |:

devient:

SHA références

Toute référence à une validation de hachage SHA-1 sera automatiquement converti en un lien vers ce commit sur GitHub.,

16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

références de problème dans un référentiel

tout nombre faisant référence à un problème ou à une demande D’extraction sera automatiquement converti en lien.

#1mojombo#1mojombo/github-flavored-markdown#1

nom d’utilisateur @mentions

en Tapant un @ symbole, suivi par un nom d’utilisateur, indiquant que la personne à venir voir le commentaire. C’est ce qu’on appelle une « @mention”, parce que vous mentionnez l’individu. Vous pouvez également @ mentionner les équipes au sein d’une organisation.,

liaison automatique pour les URL

toute URL (comme) sera automatiquement convertie en un lien cliquable.

Barré

un mot enveloppé avec deux tildes (comme ~~this~~) apparaît barré.

Emoji

GitHub prend en charge des émoticônes!

pour voir une liste de toutes les images que nous prenons en charge, consultez la feuille de triche Emoji.

Dernière mise à jour le 15 janvier 2014