Markdown est un système d’édition doté d’une syntaxe simplifiée souvent utilisé pour faire de la documentation de projet. Le format est utilisé sur de nombreux sites internet, notamment Wikipedia, Gitlab et Stackoverflow. L’extension de ce type de fichier est .md. Markdown présente deux avantages. D’une part, il est facile d’inclure des blocs de code informatique et des équations mathématiques dans un document Markdown. D’autre part, le formatage de blocs de code est simple et très bien fait (et beaucoup plus léger qu’en LaTeX par exemple).

Du text avec Markdown#

Les titres#

H1#

H2#

H3#

H4#

H5#
H6#

Code:

#H1
##H2
###H3
####H4
#####H5
######H6

Font Styles#

Bold Font or Bold Font

Code:

**Bold Font** or __Bold Font__

Italic or Italic Font

Code:

*Italic* or _Italic Font_

~~Scratched Text~~

Code:

~~Scratched Text~~

underline

Code:

<u>underline</u

Lists#

  • item

  • item

  • subitem

  • subitem

  • item

Code:

- item
- item
 - subitem
 - subitem
- item
  • One

  • Two

  • Three

Code:

+ One
- Two
* Three
  1. item

  2. item

  3. sub item

  4. sub item

  5. item

Code:

1. item
2. item
 1. sub item
 2. sub item
3. item

Les images#

Inline-style#

Code:

![alt text](https://d33wubrfki0l68.cloudfront.net/c40ce5f7cd12d07c0cb83aebf301e210500f6218/7e628/lesson-images/params-1-hawaii.png "le titre de l'image")

Inline-style:#

alt text

Reference-style:#

code

![alt text][R_Markdown]

[R_Markdown]: https://d33wubrfki0l68.cloudfront.net/c40ce5f7cd12d07c0cb83aebf301e210500f6218/7e628/lesson-images/params-1-hawaii.png "Logo Title Text 2"

Reference-style:#

alt text

HTML-style#

afin de controler la largeur de l’image par exemple:

code

<img src="smiley.gif" alt="Smiley face" height="42" width="42">
R Markdown

giphy#

alt text

Youtube ou Vimeo#

code

[![Change the World](https://i.ytimg.com/vi/B0CJpIh8d94/maxresdefault.jpg)](https://youtu.be/3sK3wJAxGfs "Inspiring: Change the World by Making Your Bed - by Admiral William McRaven - Must Watch!")

Change the World

Du code#

On peut mettre du code à l’intérieur même du texte

code

On peut mettre du `code` à l'intérieur même du texte

Par exemple :

var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
No language indicated, so no syntax highlighting. 
But let's throw in a <b>tag</b>.

code

```codeXYZ
var s = "JavaScript syntax highlighting";
alert(s);
```

Exercices#

  1. Mettez en pratique ce que vous avez appris en créant un bref CV. Le titre doit être votre nom, et vous devez inclure des rubriques pour (au moins) les études ou l’emploi. Chacune des sections doit comprendre une liste à puces des emplois/diplômes. Mettez l’année en gras.

  2. À l’aide de la référence rapide R Markdown, trouvez comment :

  • Ajouter une note de bas de page.

  • Ajouter une règle horizontale.

  • Ajouter un bloc de citation.