Markdown est un langage de balisage léger créé en 2004 par John Gruber, qui a pour objectif d’offrir une syntaxe facile à lire et à écrire. Un document balisé par Markdown peut être lu en l’état sans donner l’impression d’avoir été balisé ou formaté par des instructions particulières.
L’approche utilisée privilégie le WYSIWYM portable (what you see is what you mean), signifiant «Ce que vous voyez est ce que vous voulez dire», par opposition au WYSIWYG (what you see is “only” what you get) (« Ce que vous voyez est “uniquement” ce que vous obtenez ») qui est utilisé par les traitements de texte de type Word. On représente les informations de façon portable en fonction de leur sens, avec une meilleure séparation du fond et de la forme lors de la création de documents, ce qui permet ensuite d’avoir plusieurs types de représentation du même document (format HTML pour le web, format PDF pour l’impression, …)
Un document balisé par Markdown est portable et peut être converti en HTML, en PDF ou en d’autres formats et est aussi très utilisé sur le Web dans les blogs ou les sites de partage github ou gitlab. Il permet en outre d’écrire des formules mathématiques en utilisant la syntaxe LaTeX qui est un standard pour l’écriture de formules mathématiques dans les revues scientifiques.
Le texte suivant écrit en Markdown
## Equation du 2nd degré
- Racines réelles d'une équations du second degré
les **racines réelles** d'une équation du second degré $a x^2 + b x + c$ sont données par la formule suivante
$$ x_1, x_2 = \frac{ -b \pm \sqrt{b^2 - 4ac}}{2a} $$
- Dans le cas de racines imaginaires, il faut que:
$$ b^2 - 4 ac \lt 0 \text{ et }
x_1, x_2 = \frac{-b}{2a} \pm\mathrm{i} \frac{\sqrt{-\Delta}}{2a} $$
peut être compris tel quel et est rendu sous la forme ci-dessous :
les racines réelles d’une équation du second degré sont données par la formule suivante
attention, on écrit le texte au kilomètre sans se soucier de la mise en page
on utilise simplement un ou plusieurs # et on a pas à se soucier de la numérotation.
# titre
## section niveau 2
### sous section niveau 3donne le rendu suivant:
**mots en gras**
*idem en italique*donne le rendu suivant:
mots en gras
idem en italique
liste non ordonnée
- liste 1
- liste 2donne le rendu suivant:
liste ordonnée
1. premier
2. seconddonne le rendu suivant:
Pour inclure une image au format png, pdf ou jpeg:
Par exemple :
permet l’inclusion de la figure suivante :
On utilise la syntaxe LaTeX qui décrit une formule et ne la dessine pas !
$ formule $par exemple :
l'expression suivante $ x^2+2x+1 = 0$ est une équation du second degré devient :
l’expression suivante est une équation du second degré
$$ equation $$par exemple:
La forme factorisée de l'équation s'écrit:
$$ x^2 + 2x + 1 = (x+1)^2 $$devient :
La forme factorisée de l’équation s’écrit:
on peut insérer un lien vers une page web en utilisant une syntaxe similaire à celle des images
[titre du lien](url du lien)par exemple
[compte rendu en Markdown](Markdown.html)est rendu comme :
et renvoie vers cette page web si on clique dessus
créer un tableau en Markdown n’est pas très compliqué mais il faut faire attention aux détails.
on utilise le caractère | pour séparer les colonnes
la première ligne définie le titre des colonnes et est rendu par défaut en gras
la seconde ligne (obligatoire) définie l’alignement des colonnes avec:
--- pour un contenu aligné à gauche:-: pour un contenu centré--: pour un contenu aligné à droiteles lignes suivantes définissent le contenu des colonnes
par exemple le tableau en Markdown suivant :
| col1 | col2 | col3 |
| --- | :-: | --: |
| val1 | val2 | val3 |
[ 10 | 20 | 30 |sera rendu comme ci-dessous :
| col1 | col2 | col3 |
|---|---|---|
| val1 | val2 | val3 |
| 10 | 20 | 30 |
Dans un rapport ou un compte rendu il est important de citer ses sources. En science, le référencement bibliographique obéit à des règles qui assurent que l’information peut être retrouvée et référencée.
La forme d’une bibliographie suit quelques règles de base :
Une liste de références se place en général à la fin d’un document
Les références sont en générale classées par ordre alphabétique du nom des auteurs.
Pour la référence d’un livre, articles, ouvrages, le modèle standard est:
Pour un document en ligne
Lorsque le document contient beaucoup de références, on utilise des outils pour gérer ces références, par exemple bibtex, jabref …
Pour chacun des TP, on vous demandera d’écrire un compte rendu utilisant la notation Markdown dans le fichier CompteRendu.md
Le format Markdown permet de rapidement et très simplement rédiger du texte structuré. Ce cours est par exemple complètement rédigé en Markdown :-)
Utiliser le menu Fichier pour éditer le fichier de compte rendu au format Markdown: CompteRendu.md dans un onglet du navigateur
Modifier ce fichier en indiquant le nom du TP, votre nom et prénom et en remplissant les paragraphes.
attention bien laisser un espace après title: et author:
attention bien insérer des lignes vides pour indiquer des fins de paragraphes
inclusion de figure dans le compte rendu avec la ligne suivante séparée par 2 lignes blanches:
attention à bien sauter une ligne avec et après cette commande et penser à commenter chaque figure !
aérer le texte en laissant des lignes vides entre chaque paragraphe
Relisez et corrigez l’orthographe
Utiliser ensuite la commande ci-dessous pour générer une version en html avec mise en page du compte-rendu.
!genereTPhtml CompteRenduVisualisation du Compte Rendu au format html
CompteRendu.html pour l’ouvrir dans un onglet du navigateurDans la dernière version de jupyterlab, l’éditeur de fichier markdown possède une option de preview qui permet de visualiser le rendu du fichier. Pour cela on clique droit avec la souris pour sélectionner “Show Markdown Preview”, ce qui affiche une fenêtre avec le rendu du fichier.
Le logiciel libre ghostwriter est un éditeur sophistiqué de fichier markdown avec une pré-visualisation du rendu et un correcteur orthographique. Il est disponible sur les serveurs jupyter avec xpra.
Le compte rendu suivant sur l’analyse de la danse des pendules “swinging pendulum” est écrit en Markdown et convertit en html et pdf avec la commande suivante:
genereTPhtml -pdf CompteRendula version source en Markdown à télécharger
Nous vous conseillons d’explorer les possibilités du Markdown en consultant le site suivant:
et pour aller plus loin: