1
0
mirror of synced 2026-01-09 15:02:41 -05:00

Merge pull request #18007 from github/repo-sync

repo sync
This commit is contained in:
Octomerger Bot
2022-05-19 12:10:16 -05:00
committed by GitHub
15 changed files with 82 additions and 18 deletions

View File

@@ -210,6 +210,3 @@ jobs:
dockerRegistryUrl="${{ secrets.NONPROD_REGISTRY_SERVER }}"
dockerRegistryUsername="${{ env.NONPROD_REGISTRY_USERNAME }}"
dockerRegistryPassword="${{ secrets.NONPROD_REGISTRY_PASSWORD }}"
# this shows warnings in the github actions console, because the flag is passed through a validation run,
# but it *is* functional during the actual execution
additionalArguments: --no-wait

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

View File

@@ -14,6 +14,7 @@ children:
- /organizing-information-with-collapsed-sections
- /creating-and-highlighting-code-blocks
- /creating-diagrams
- /writing-mathematical-expressions
- /autolinked-references-and-urls
- /attaching-files
- /creating-a-permanent-link-to-a-code-snippet

View File

@@ -0,0 +1,59 @@
---
title: Writing mathematical expressions
intro: 'Use Markdown to display mathematical expressions on {% data variables.product.company_short %}.'
versions:
feature: math
shortTitle: Mathematical expressions
---
To enable clear communication of mathematical expressions, {% data variables.product.product_name %} supports LaTeX formatted math within Markdown. For more information, see [LaTeX/Mathematics](http://en.wikibooks.org/wiki/LaTeX/Mathematics) in Wikibooks.
{% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide).
## Writing inline expressions
To include a math 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$
```
![Inline math markdown rendering](/assets/images/help/writing/inline-math-markdown-rendering.png)
## Writing expressions as blocks
To add a math expression as a block, start a new line and delimit the expression with two dollar symbols `$$`.
```
**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)$$
```
![Math expression as a block rendering](/assets/images/help/writing/math-expression-as-a-block-rendering.png)
## Writing dollar signs in line with and within mathematical expressions
To display a dollar sign as a character in the same line as a mathematical expression, you need to escape the non-delimiter `$` to ensure the line renders correctly.
- Within a math expression, add a `\` symbol before the explicit `$`.
```
This expression uses `\$` to display a dollar sign: $\sqrt{\$4}$
```
![Dollar sign within math expression](/assets/images/help/writing/dollar-sign-within-math-expression.png)
- Outside a math expression, but on the same line, use span tags around the explicit `$`.
```
To split <span>$</span>100 in half, we calculate $100/2$
```
![Dollar sign inline math expression](/assets/images/help/writing/dollar-sign-inline-math-expression.png)
## Further reading
* [The MathJax website](http://mathjax.org)
* [Getting started with writing and formatting on GitHub](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)

7
data/features/math.yml Normal file
View File

@@ -0,0 +1,7 @@
# Issues 6054
# Math support using LaTeX syntax
versions:
fpt: '*'
ghec: '*'
ghes: '>=3.6'
ghae: 'issue-6054'

View File

@@ -5368,7 +5368,7 @@ input CreateBranchProtectionRuleInput {
pattern: String!
"""
A list of User, Team or App IDs allowed to push to matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]
@@ -39257,7 +39257,7 @@ input UpdateBranchProtectionRuleInput {
pattern: String
"""
A list of User, Team or App IDs allowed to push to matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]

View File

@@ -5651,7 +5651,7 @@ input CreateBranchProtectionRuleInput {
pattern: String!
"""
A list of User, Team or App IDs allowed to push to matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]
@@ -45282,7 +45282,7 @@ input UpdateBranchProtectionRuleInput {
pattern: String
"""
A list of User, Team or App IDs allowed to push to matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]

View File

@@ -5651,7 +5651,7 @@ input CreateBranchProtectionRuleInput {
pattern: String!
"""
A list of User, Team or App IDs allowed to push to matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]
@@ -45282,7 +45282,7 @@ input UpdateBranchProtectionRuleInput {
pattern: String
"""
A list of User, Team or App IDs allowed to push to matching branches.
A list of User, Team, or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]

File diff suppressed because one or more lines are too long

View File

@@ -76417,7 +76417,7 @@
},
{
"name": "pushActorIds",
"description": "<p>A list of User, Team or App IDs allowed to push to matching branches.</p>",
"description": "<p>A list of User, Team, or App IDs allowed to push to matching branches.</p>",
"type": "[ID!]",
"id": "id",
"kind": "scalars",
@@ -82172,7 +82172,7 @@
},
{
"name": "pushActorIds",
"description": "<p>A list of User, Team or App IDs allowed to push to matching branches.</p>",
"description": "<p>A list of User, Team, or App IDs allowed to push to matching branches.</p>",
"type": "[ID!]",
"id": "id",
"kind": "scalars",

View File

@@ -66310,7 +66310,7 @@
},
{
"name": "pushActorIds",
"description": "<p>A list of User, Team or App IDs allowed to push to matching branches.</p>",
"description": "<p>A list of User, Team, or App IDs allowed to push to matching branches.</p>",
"type": "[ID!]",
"id": "id",
"kind": "scalars",
@@ -71023,7 +71023,7 @@
},
{
"name": "pushActorIds",
"description": "<p>A list of User, Team or App IDs allowed to push to matching branches.</p>",
"description": "<p>A list of User, Team, or App IDs allowed to push to matching branches.</p>",
"type": "[ID!]",
"id": "id",
"kind": "scalars",

View File

@@ -76417,7 +76417,7 @@
},
{
"name": "pushActorIds",
"description": "<p>A list of User, Team or App IDs allowed to push to matching branches.</p>",
"description": "<p>A list of User, Team, or App IDs allowed to push to matching branches.</p>",
"type": "[ID!]",
"id": "id",
"kind": "scalars",
@@ -82172,7 +82172,7 @@
},
{
"name": "pushActorIds",
"description": "<p>A list of User, Team or App IDs allowed to push to matching branches.</p>",
"description": "<p>A list of User, Team, or App IDs allowed to push to matching branches.</p>",
"type": "[ID!]",
"id": "id",
"kind": "scalars",