Merge branch 'main' into feature/improve-footnotes-docs
This commit is contained in:
Laura Coursen
@@ -12,6 +12,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
## About gists
|
||||
|
||||
@@ -36,7 +37,7 @@ You'll receive a notification when:
|
||||
- Someone mentions you in a gist.
|
||||
- You subscribe to a gist, by clicking **Subscribe** at the top of any gist.
|
||||
|
||||
{% ifversion fpt or ghes %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
|
||||
You can pin gists to your profile so other people can see them easily. For more information, see "[Pinning items to your profile](/articles/pinning-items-to-your-profile)."
|
||||
|
||||
@@ -48,7 +49,7 @@ Since gists are Git repositories, you can view their full commit history, comple
|
||||
|
||||
You can download a ZIP file of a gist by clicking the **Download ZIP** button at the top of the gist. You can embed a gist in any text field that supports Javascript, such as a blog post. To get the embed code, click the clipboard icon next to the **Embed** URL of a gist. To embed a specific gist file, append the **Embed** URL with `?file=FILENAME`.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)."
|
||||
|
||||
@@ -58,7 +59,7 @@ Gist supports mapping GeoJSON files. These maps are displayed in embedded gists,
|
||||
|
||||
Follow the steps below to create a gist.
|
||||
|
||||
{% ifversion fpt or ghes or ghae %}
|
||||
{% ifversion fpt or ghes or ghae or ghec %}
|
||||
{% note %}
|
||||
|
||||
You can also create a gist using the {% data variables.product.prodname_cli %}. For more information, see "[`gh gist create`](https://cli.github.com/manual/gh_gist_create)" in the {% data variables.product.prodname_cli %} documentation.
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
## Forking gists
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /creating-gists
|
||||
- /forking-and-cloning-gists
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Write & format on GitHub
|
||||
---
|
||||
[Markdown](http://daringfireball.net/projects/markdown/) is an easy-to-read, easy-to-write syntax for formatting plain text.
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Basic formatting syntax
|
||||
---
|
||||
## Headings
|
||||
@@ -54,7 +55,7 @@ Text that is not a quote
|
||||
|
||||
## Quoting code
|
||||
|
||||
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.{% ifversion fpt or ghae-next or ghes > 3.1 %} You can also press the `command` or `Ctrl` + `e` keyboard shortcut to insert the backticks for a code block within a line of Markdown.{% endif %}
|
||||
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %} You can also press the `command` or `Ctrl` + `e` keyboard shortcut to insert the backticks for a code block within a line of Markdown.{% endif %}
|
||||
|
||||
```markdown
|
||||
Use `git status` to list all new or modified files that haven't yet been committed.
|
||||
@@ -79,7 +80,7 @@ For more information, see "[Creating and highlighting code blocks](/articles/cre
|
||||
|
||||
## Links
|
||||
|
||||
You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. {% ifversion fpt or ghae-next or ghes > 3.1 %}You can also use the keyboard shortcut `command + k` to create a link.{% endif %}
|
||||
You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can also use the keyboard shortcut `command + k` to create a link.{% endif %}
|
||||
|
||||
`This site was built using [GitHub Pages](https://pages.github.com/).`
|
||||
|
||||
@@ -107,7 +108,7 @@ You can display an image by adding `!` and wrapping the alt text in`[ ]`. Then w
|
||||
|
||||
|
||||
|
||||
{% data variables.product.product_name %} supports embedding images into your issues, pull requests{% ifversion fpt %}, discussions{% endif %}, comments and `.md` files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see "[Uploading assets](#uploading-assets)."
|
||||
{% data variables.product.product_name %} supports embedding images into your issues, pull requests{% ifversion fpt or ghec %}, discussions{% endif %}, comments and `.md` files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see "[Uploading assets](#uploading-assets)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
@@ -207,7 +208,7 @@ For more information, see "[About task lists](/articles/about-task-lists)."
|
||||
|
||||
## Mentioning people and teams
|
||||
|
||||
You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing `@` plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% ifversion fpt or ghes or ghae %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
|
||||
You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing `@` plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
|
||||
|
||||
`@github/support What do you think about these updates?`
|
||||
|
||||
@@ -235,7 +236,7 @@ Some {% data variables.product.prodname_github_apps %} provide information in {%
|
||||
|
||||
|
||||
|
||||
To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% ifversion fpt %} For more information, see "[Installing an app in your personal account](/articles/installing-an-app-in-your-personal-account)" and "[Installing an app in your organization](/articles/installing-an-app-in-your-organization)."{% endif %}
|
||||
To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% ifversion fpt or ghec %} For more information, see "[Installing an app in your personal account](/articles/installing-an-app-in-your-personal-account)" and "[Installing an app in your organization](/articles/installing-an-app-in-your-organization)."{% endif %}
|
||||
|
||||
Content attachments will not be displayed for URLs that are part of a markdown link.
|
||||
|
||||
@@ -261,7 +262,7 @@ For a full list of available emoji and codes, check out [the Emoji-Cheat-Sheet](
|
||||
|
||||
You can create a new paragraph by leaving a blank line between lines of text.
|
||||
|
||||
{% ifversion fpt or ghae-next or ghes > 3.3 %}
|
||||
{% ifversion fpt or ghae-next or ghes > 3.3 or ghec %}
|
||||
## Footnotes
|
||||
|
||||
You can add footnotes to your content by using this bracket syntax:
|
||||
@@ -310,7 +311,7 @@ You can tell {% data variables.product.product_name %} to ignore (or escape) Mar
|
||||
|
||||
For more information, see Daring Fireball's "[Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash)."
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-5232 %}
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-5232 or ghec %}
|
||||
|
||||
## Disabling Markdown rendering
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /about-writing-and-formatting-on-github
|
||||
- /basic-writing-and-formatting-syntax
|
||||
|
||||
@@ -10,6 +10,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /getting-started-with-writing-and-formatting-on-github
|
||||
- /working-with-advanced-formatting
|
||||
|
||||
@@ -10,13 +10,14 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
---
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** If you add an image{% ifversion fpt or ghes > 3.1 or ghae-next %} or video{% endif %} to a pull request or issue comment, anyone can view the anonymized URL without authentication, even if the pull request is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt %}For more information on anonymized URLs see "[About anonymized URLs](/github/authenticating-to-github/about-anonymized-urls)".{% endif %}
|
||||
**Warning:** If you add an image{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %} or video{% endif %} to a pull request or issue comment, anyone can view the anonymized URL without authentication, even if the pull request is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt or ghec %}For more information on anonymized URLs see "[About anonymized URLs](/github/authenticating-to-github/about-anonymized-urls)".{% endif %}
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
@@ -31,7 +32,7 @@ To attach a file to an issue or pull request conversation, drag and drop it into
|
||||
{% endtip %}
|
||||
|
||||
The maximum file size is:
|
||||
- 10MB for images and gifs{% ifversion fpt %}
|
||||
- 10MB for images and gifs{% ifversion fpt or ghec %}
|
||||
- 10MB for videos uploaded to a repository owned by a user or organization on a free GitHub plan
|
||||
- 100MB for videos uploaded to a repository owned by a user or organization on a paid GitHub plan{% elsif fpt or ghes > 3.1 or ghae-next %}
|
||||
- 100MB for videos{% endif %}
|
||||
@@ -46,7 +47,7 @@ We support these files:
|
||||
* Microsoft Word (*.docx*), Powerpoint (*.pptx*), and Excel (*.xlsx*) documents
|
||||
* Text files (*.txt*)
|
||||
* PDFs (*.pdf*)
|
||||
* ZIP (*.zip*, *.gz*){% ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
* ZIP (*.zip*, *.gz*){% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
|
||||
* Video (*.mp4*, *.mov*)
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Auto linked references
|
||||
---
|
||||
## URLs
|
||||
@@ -38,7 +39,7 @@ Within conversations on {% data variables.product.product_name %}, references to
|
||||
| `Username/Repository#` and issue or pull request number | jlord/sheetsee.js#26 | [jlord/sheetsee.js#26](https://github.com/jlord/sheetsee.js/issues/26)
|
||||
| `Organization_name/Repository#` and issue or pull request number | github/linguist#4039 | [github/linguist#4039](https://github.com/github/linguist/pull/4039)
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
If you reference an issue, pull request, or discussion in a list, the reference will unfurl to show the title and state instead. For more information about task lists, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)."
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Pull requests
|
||||
shortTitle: Permanent links to code
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Create code blocks
|
||||
---
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /organizing-information-with-tables
|
||||
- /creating-and-highlighting-code-blocks
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Organized data with tables
|
||||
---
|
||||
## Creating a table
|
||||
|
||||
@@ -5,6 +5,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Issues
|
||||
- Pull requests
|
||||
@@ -12,7 +13,7 @@ topics:
|
||||
|
||||
## Linking a pull request to an issue
|
||||
|
||||
To link a pull request to an issue to{% ifversion fpt or ghes or ghae %} show that a fix is in progress and to{% endif %} automatically close the issue when someone merges the pull request, type one of the following keywords followed by a reference to the issue. For example, `Closes #10` or `Fixes octo-org/octo-repo#100`.
|
||||
To link a pull request to an issue to{% ifversion fpt or ghes or ghae or ghec %} show that a fix is in progress and to{% endif %} automatically close the issue when someone merges the pull request, type one of the following keywords followed by a reference to the issue. For example, `Closes #10` or `Fixes octo-org/octo-repo#100`.
|
||||
|
||||
* close
|
||||
* closes
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.saved_replies %}
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.saved_replies %}
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.saved_replies %}
|
||||
|
||||
@@ -7,6 +7,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /about-saved-replies
|
||||
- /creating-a-saved-reply
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issue-pr %}
|
||||
|
||||
Reference in New Issue
Block a user