Aller au contenu principal

Markdown

Markdown est un langage de markup, c'est-à-dire une syntaxe pour pimper votre texte : le mettre en gras, en italique, faire des titres, mettre des liens, etc. Par exemple, voici la documentation de la librairie sil, qui est écrite en Markdown.

Extensions​

Vous aurez besoin de ces extensions pour facilement écrire du markdown dans VS Code :

  • markdown-preview-enhanced Pour voir le rendu final de votre texte.

  • markdown-all-in-one Pour que VSCode comprenne la syntaxe Markdown.

  • code-spell-checker-french Un correcteur d'orthographe. ATTENTION il est par défaut en anglais, et pour activer le français il faut faire ces manips :

    • Faites F1 puis cherchez et cliquez sur Show Spell Checker Configuration Info
    • Sélectionnez l'onglet "User"
    • Activez le langage français en plus de l'anglais (quand il demande Choose Destination, sélectionnez User et pas Workspace).

Syntaxe​

Voici une cheatsheet où vous retrouvez tout la syntaxe.

En résumé :

*Italique*

**Gras**

[lien](https://github.com/dsmtE/Learn--cpp_programming)

![image](./output/pouet.png)

#### Titre (plus ou moins gros en fonction du nombre de #)

- Listes
- avec
- plusieurs items
```cpp
// Bloc de code C++
int x{0};
std::cout << "x vaut " << x << '\n';
'``

Bout de code `int x0;` au milieu d'une phrase.

Équations de math avec LaTeX :

$$
\int_{-\infty{}}^{+\infty{}} x^2 dx
$$

Notes de bas de page [^1]

[^1]: Je suis une note de bas de page !

> Citation

| Tableaux      | :grin:        | :sparkles:  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

Séparateur :

---

Et vous pouvez également utiliser n'importe quelle balise html à tout moment, si la syntaxe Markdown ne fournit pas de quoi faire ce que vous voulez. Par exemple :

  • <kbd>F2</kbd> pour faire des touches : F2
  • <summary></summary> et <details></details> pour faire des sections collapsables :
<details>
  <summary>Ouvre-moi !</summary>
Salut, ceci est un secret !
</details>
Details

Ouvre-moi ! Salut, ceci est un secret !

Générer une table des matières​

VS Code peut générer automatiquement une table des matières pour votre document, qui va lister toutes les différentes sections que vous aurez délimitées avec des titres (#, ##, ###, etc.).
Pour cela, mettez votre curseur là où vous voulez la générer (typiquement au début de votre document), puis faites F1 et cherchez et sélectionnez Markdown All In One: Create Table of Contents (ou juste toc pour faire court).

Footnotes​

  1. Je suis une note de bas de page ! ↩