Enterprise Server 3.15 está disponível no momento como versão release candidate.

Como escrever expressões matemáticas

Use o Markdown para exibir expressões matemáticas no GitHub.

Neste artigo

Sobre como escrever expressões matemáticas

Para permitir a comunicação clara das expressões matemáticas, o GitHub Enterprise Server dá suporte à matemática formatada LaTeX no Markdown. Para obter mais informações, confira LaTeX/matemática no Wikibooks.

A funcionalidade de renderização de matemática do GitHub usa o MathJax, um mecanismo de exibição baseado em JavaScript, de código aberto. O MathJax dá suporte a uma ampla variedade de macros LaTeX e a várias extensões de acessibilidade úteis. Para obter mais informações, confira a documentação do MathJax e a documentação de Extensões de Acessibilidade do MathJax.

A renderização das expressões matemáticas está disponível em GitHub Issues, GitHub Discussions, em pull requests, wikis e arquivos markdown.

Como escrever expressões embutidas

Há duas opções para delimitar uma expressão matemática embutida com texto. Você pode colocar a expressão entre símbolos de dólar ($) ou iniciar a expressão com $` e encerrá-la com `$. A segunda sintaxe é útil quando a expressão contém caracteres que se sobrepõem à sintaxe markdown. Para obter mais informações, confira "Sintaxe básica de gravação e formatação no GitHub".

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

Captura de tela do Markdown renderizado mostrando como uma expressão matemática é exibida no GitHub. A equação é √3 x -1 + (1 + x)².

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

Captura de tela do Markdown renderizado mostrando como uma expressão matemática é exibida embutida no GitHub. A equação é √3 x -1 + (1 + x)².

Como escrever expressões como blocos

Para adicionar uma expressão matemática como um bloco, inicie uma nova linha e delimite a expressão com dois símbolos de dólar $$.

**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)$$

Captura de tela do Markdown renderizado mostrando como uma equação complexa é exibida no GitHub. O texto em negrito diz "A desigualdade Cauchy-Schwarz". Abaixo do texto, há uma equação mostrando o parêntese aberto com a soma de k igual a 1 a n de um sub k b sub k e o parêntese fechado ao quadrado como menor ou igual ao parêntese aberto com a soma de k igual a 1 a n de um sub k ao quadrado e parênteses fechado vezes parêntesis aberto com a soma de k igual a 1 a n de b sub k ao quadrado e parênteses fechado.

Como alternativa, você pode usar a sintaxe do bloco de código ```math para exibir uma expressão matemática como um bloco. Com essa sintaxe, você não precisa usar delimitadores $$. O seguinte renderizará igual à opção acima:

**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)
```

Como escrever sinais de dólar embutidos em expressões matemáticas

Para exibir um sinal de dólar como um caractere na mesma linha que uma expressão matemática, você precisa fazer o escape do não delimitador $ para garantir que a linha seja renderizada corretamente.

  • Dentro de uma expressão matemática, adicione um símbolo \ antes do $ explícito.

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

    Captura de tela do Markdown renderizado mostrando como uma barra invertida antes de um sinal de dólar exibe o sinal como parte de uma expressão matemática.

  • Fora de uma expressão matemática, mas na mesma linha, coloque o $ explícito entre tags span.

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

    Captura de tela do Markdown renderizado mostrando como as marcas de extensão ao redor de um sinal de dólar exibem o sinal como um texto embutido em vez de como parte de uma equação matemática.

Leitura adicional