-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Description
Summary
Mathematical expressions are key to information sharing in academia and among engineers, scientists, economists, statisticians, and others. Support for displaying mathematical expressions was released to GitHub Cloud in May, 2022. Next, math support will be added to GitHub Enterprise Server.
Intended Outcome
This feature will add native support for using LaTeX-style syntax to render mathematical expressions where Markdown is supported in issues, repositories, and discussions. Expressions can be added inline in Markdown or as separate expression blocks.
How will it work?
Writing expressions as blocks
To add mathematical expressions as a multiline block displayed separately from surrounding text, start a new line and delimit the expression with the ```math code block syntax.
```math
**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)$$
```
Writing inline expressions
To include a mathematical expression inline with your text, delimit the expression with a dollar symbol $.
This sentence uses `$` delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$
GitHub Enterprise Server's math rendering capability will use MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros and a number of useful accessibility extensions. For more information, see the MathJax documentation and the MathJax Accessibility Extensions documentation.
For more information about authoring content with advanced formatting, see Working with advanced formatting in the GitHub documentation.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status

