Écriture d’expressions mathématiques

Utilisez Markdown pour afficher des expressions mathématiques sur GitHub.

Dans cet article

À propos de l’écriture d’expressions mathématiques

Pour activer la communication claire d’expressions mathématiques, GitHub Enterprise Cloud prend en charge les mathématiques mises en forme LaTeX dans Markdown. Pour plus d’informations, consultez LaTeX/Mathematics dans Wikibooks.

La fonctionnalité de rendu mathématique de GitHub utilise MathJax ; un moteur d’affichage open source basé sur JavaScript. MathJax prend en charge un large éventail de macros LaTeX et plusieurs extensions d’accessibilité utiles. Pour plus d’informations, consultez la documentation MathJax et la documentation sur les extensions d’accessibilité MathJax.

Le rendu des expressions mathématiques est disponible dans GitHub Issues, GitHub Discussions, les demandes de tirage, les wikis et les fichiers Markdown.

Écriture d’expressions inlined

Il existe deux options pour délimiter une expression mathématique inline avec votre texte. Vous pouvez entourer l’expression de symboles dollar ($), ou commencer l’expression par $` et la terminer par `$. Cette dernière syntaxe est utile lorsque l’expression que vous écrivez contient des caractères qui chevauchent la syntaxe Markdown. Pour plus d’informations, consultez « Syntaxe de base pour l’écriture et la mise en forme ».

This sentence uses `$` delimiters to show math inline:  $\sqrt{3x-1}+(1+x)^2$

Capture d’écran du Markdown rendu montrant comment une expression mathématique s’affiche sur GitHub. L’équation est la racine carrée de 3 x moins 1 plus parenthèse ouvrante 1 plus x parenthèse fermante au carré.

This sentence uses $\` and \`$ delimiters to show math inline:  $`\sqrt{3x-1}+(1+x)^2`$

Capture d’écran du Markdown rendu montrant comment une expression mathématique s’affiche inline sur GitHub. L’équation est la racine carrée de 3 x moins 1 plus parenthèse ouvrante 1 plus x parenthèse fermante au carré.

Écriture d’expressions en tant que blocs

Pour ajouter une expression mathématique en tant que bloc, démarrez une nouvelle ligne et délimitez l’expression avec deux symboles du dollar $$.

**The Cauchy-Schwarz Inequality**
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

Capture d’écran du Markdown rendu montrant comment une équation complexe s’affiche sur GitHub. Le texte en gras indique « L’inégalité Cauchy-Schwarz ». Sous le texte figure une équation montrant parenthèse ouvrante la somme de k égale 1 à n d’un sub k b sub k parenthèse fermante au carré est inférieure ou égale à parenthèse ouvrante la somme de k égale 1 à n d’un sub k au carré parenthèse fermante fois parenthèse ouvrante la somme de k égale 1 à n de b sub k au carré parenthèse fermante.

Vous pouvez également utiliser la syntaxe de bloc de code ```math pour afficher une expression mathématique en tant que bloc. Avec cette syntaxe, vous n’avez pas besoin d’utiliser des délimiteurs $$. Le rendu suivant est identique à celui ci-dessus :

**The Cauchy-Schwarz Inequality**

```math
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
```

Écriture de signes dollar en ligne avec et dans les expressions mathématiques

Pour afficher un signe dollar sous la forme d’un caractère dans la même ligne qu’une expression mathématique, vous devez échapper au $ non délimiteur pour vous assurer que la ligne s’affiche correctement.

  • Dans une expression mathématique, ajoutez un symbole \ avant $ explicite.

    This expression uses `\$` to display a dollar sign: $`\sqrt{\$4}`$

    Capture d’écran du Markdown rendu montrant comment une barre oblique inverse devant un signe dollar affiche le signe dans le cadre d’une expression mathématique.

  • En dehors d’une expression mathématique, mais sur la même ligne, utilisez des balises d’étendue autour de $ explicite.

    To split <span>$</span>100 in half, we calculate $100/2$

    Capture d’écran du Markdown rendu montrant comment les balises span autour d’un signe dollar affichent le signe en tant que texte inline plutôt qu’en tant que partie d’une équation mathématique.

Pour aller plus loin