Aide-mémoire Markdown

Un pense-bête de toute la syntaxe Markdown qui fonctionne sur LFMarkdown, avec pour chaque élément un exemple à copier. L’outil suit les spécifications CommonMark et GitHub Flavored Markdown : ce qui s’affiche sur GitHub s’affiche ici aussi.

Texte

**gras**  *italique*  ~~barré~~  `code`
==surligné==  ||spoiler||  __souligné__
H~2~O et x^2^
-# petites lignes

Titres

# Titre 1
## Titre 2
### Titre 3

Chaque titre reçoit automatiquement une ancre.

Listes

- Puce
- Une autre
  - Imbriquée

1. Premier
2. Deuxième

- [x] Tâche terminée
- [ ] Tâche à faire

Liens et images

[Texte du lien](https://example.com)
![Texte alternatif](https://example.com/image.png)
[[LienWiki]]
[[LienWiki|Libellé personnalisé]]

Code

Encadrez un bloc et nommez le langage pour la coloration syntaxique :

```ruby
def publish(markdown)
  Document.create!(content: markdown)
end
```

Des dizaines de langages sont pris en charge, dont JavaScript, TypeScript, Python, Rust, Go, SQL, YAML, JSON, Bash, CSS et HTML. La coloration se fait côté serveur : elle fonctionne même sans JavaScript.

Tableaux

| Gauche | Centre | Droite |
|:-------|:------:|-------:|
| a      |   b    |      c |

Encarts

> [!NOTE]
> Information utile.

> [!TIP]
> Une suggestion.

> [!IMPORTANT]
> Un point à retenir.

> [!WARNING]
> Un point de vigilance.

> [!CAUTION]
> Quelque chose de risqué.

Formules

Écrites en TeX, rendues avec KaTeX :

En ligne : $E = mc^2$

En bloc :

$$\sum_{i=1}^{n} i = \frac{n(n+1)}{2}$$

Diagrammes

Encadrez un bloc en mermaid :

```mermaid
graph LR
  Write --> Publish --> Share
```

Organigrammes, diagrammes de séquence, de classes, d’états, camemberts et diagrammes de Gantt fonctionnent tous.

Front matter

Un bloc YAML tout en haut devient une fiche de propriétés, et son title nomme le document :

---
title: Notes de version
author: Votre nom
---

Notes de bas de page

Une affirmation.[^1]

[^1]: Le détail qui la soutient.

Limites

Les documents font entre 3 caractères et 500 Ko. Le HTML brut est supprimé plutôt que rendu : c’est ce qui rend les documents publiés sûrs à ouvrir.