Archives Wild Code School
Wild

Apprendre le Markdown

Quête 1 sur 1 · 1 image archivée

Introduction

Logo Markdown en blanc sur fond bleu

Markdown est un langage de balisage léger créé par John Gruber et Aaron Swartz en 2004. Son but est d'offrir une syntaxe facile à lire et à écrire. Un document formaté selon Markdown devrait pouvoir être publié comme tel, en texte, sans donner l’impression qu’il a été marqué par des balises ou des instructions de formatage.

Un document rédigé en Markdown peut être converti facilement en HTML. On obtient ainsi un document qui peut comporter des liens, des listes, des images, du formatage de texte (gras, italique), une hiérarchie de titres (h1, h2,...h6), et même des blocs de code avec une coloration de la syntaxe.

Son extension est le .md. Tu peux t’en servir à de nombreuses occasions, notamment pour rédiger de la documentation. Par exemple, lorsque tu arrives sur un dépôt sur Github, le texte que tu vois en premier correspond au contenu du fichier README.md rédigé en Markdown. C’est pour cette raison que Github t’incite à en renseigner un lors de la création d’un dépôt.

Autre exemple, le contenu de cette quête a été rédigé par l’un de tes formateurs en Markdown ! Odyssey, parcourt le code markdown enregistré pour le convertir en HTML. Les feuilles de style CSS et ton navigateur finisse de faire le travail pour afficher cette quête de façon plus élégante. L’avantage, c’est qu’à partir d’une syntaxe simple et standardisée, facile à rédiger, il est possible d’en ressortir un contenu mis en forme de manière homogène sur les différentes pages, parfaitement intégré à la plateforme.

Voici cette introduction en Markdown, telle que son auteur l'a écrite :

markdown
# Introduction

![Logo Markdown en blanc sur fond bleu](images/001-logo-markdown-en-blanc-sur-fond-bleu.jpg)

Markdown est un langage de balisage léger créé par [John Gruber](https://fr.wikipedia.org/wiki/John_Gruber) et [Aaron Swartz](https://fr.wikipedia.org/wiki/Aaron_Swartz) en 2004.
Son but est d'offrir une syntaxe **facile à lire et à écrire**. Un document formaté selon Markdown devrait pouvoir être publié comme tel, en texte, sans donner l’impression qu’il a été marqué par des balises ou des instructions de formatage.

Un document rédigé en Markdown **peut être converti facilement en HTML**. On obtient ainsi un document qui peut comporter des liens, des listes, des images, du formatage de texte (gras, italique), une hiérarchie de titres (h1, h2,...h6), et même des blocs de code avec une coloration de la syntaxe.

Son extension est le `.md`. Tu peux t’en servir à de nombreuses occasions, notamment pour rédiger de la documentation. Par exemple, lorsque tu arrives sur un dépôt sur Github, le texte que tu vois en premier correspond au contenu du fichier README.md rédigé en Markdown. C’est pour cette raison que Github t’incite à en renseigner un lors de la création d’un dépôt.

Autre exemple, le contenu de cette quête a été rédigé par l’un de tes formateurs en Markdown !
Odyssey, parcourt le *code* markdown enregistré pour le convertir en [HTML](https://developer.mozilla.org/fr/docs/Web/HTML).
Les feuilles de style [CSS](https://developer.mozilla.org/fr/docs/Learn/Getting_started_with_the_web/CSS_basics) et ton navigateur finisse de faire le travail pour afficher cette quête de façon plus élégante.
L’avantage, c’est qu’à partir d’une syntaxe simple et standardisée, facile à rédiger, il est possible d’en ressortir un contenu mis en forme de manière homogène sur les différentes pages, parfaitement intégré à la plateforme.

Voici cette introduction en Markdown, telle que son auteur l'a écrite :

Il est possible d'écrire en Markdown sur de nombreux sites web :

  • GitHub : le README, les commentaires (de Pull Request par exemple), les Issues, les gists, etc.

  • StackOverflow : dans les questions / réponses

  • Discourse : dans les discussions

  • Ghost pour écrire des articles de blog

  • et bien d'autres ...

Objectifs

  • Comprendre l'utilité de Markdown

  • Structurer un texte grâce à la syntaxe Markdown

Découvrir la syntaxe

↗
Learn Markdown

Remets-en une couche avec cette introduction à la syntaxe.

gitbookio.gitbooks.io
↗
Dillinger

Un éditeur de texte qui génère une prévisualisation du Markdown en HTML. Un bon moyen de s'amuser et d'expérimenter avec la syntaxe.

dillinger.io
↗
Markdown tutorial

Réalise la totalité de ce tutoriel interactif dans le navigateur.

markdowntutorial.com

Les références

Une liste de liens à garder sous le coude et à consulter en cas de doute.

↗
Markdown Cheatsheet

Une antisèche sur la syntaxe Markdown.

github.com
↗
Github Flavored markdown

Le guide officiel d'introduction au Markdown rédigé par Github. Avec quelques spécificités de la version de Markdown utilisée sur Github.

guides.github.com

Challenge

Rédiger un CV en MarkDown

À partir des ressources ci-dessus, rédige un mini CV avec les rubriques suivantes :

shell
* Présentation
* Formation
* Expérience professionnelle
* Hobbies

Prépare bien ce mini CV, il peut te servir de premier jet pour la rédaction de ton futur CV, beaucoup plus travaillé, que tu enverras aux entreprises lors de ta prochaine recherche de stage.

Critères de validation

  • Ton CV est disponible sur github,
  • Le CV contient a minima :

les rubriques demandées :

Présentation;Formation;Expérience professionnelle;Hobbies;des liens vers des URLs extérieures,une photo de profil (hébergée sur Github, ou non),du texte en gras (nom d’entreprises ou d’écoles),du texte en italique (description des postes en expériences professionnelles).

Ressources partagées sur cette quête