updating content files

2025-12-22 11:26:57 -05:00 · 2021-06-14 12:06:52 -07:00
parent 850ab9ccb4
commit 6f7e4f50dc
1154 changed files with 6299 additions and 6267 deletions
--- a/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md
+++ b/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md
@@ -12,7 +12,7 @@ versions:
  enterprise-server: '*'
  github-ae: '*'
 ---
-### About gists
+## About gists

 Every gist is a Git repository, which means that it can be forked and cloned. {% if currentVersion != "github-ae@latest" %}If you are signed in to {% data variables.product.product_name %} when{% else %}When{% endif %} you create a gist, the gist will be associated with your account and you will see it in your list of gists when you navigate to your {% data variables.gists.gist_homepage %}.

@@ -53,7 +53,7 @@ Gist supports mapping GeoJSON files. These maps are displayed in embedded gists,

 {% endif %}

-### Creating a gist
+## Creating a gist

 Follow the steps below to create a gist.

--- a/content/github/writing-on-github/editing-and-sharing-content-with-gists/forking-and-cloning-gists.md
+++ b/content/github/writing-on-github/editing-and-sharing-content-with-gists/forking-and-cloning-gists.md
@@ -9,19 +9,19 @@ versions:
  enterprise-server: '*'
  github-ae: '*'
 ---
-### Forking gists
+## Forking gists

 Each gist indicates which forks have activity, making it easy to find interesting changes from others.

 ![Gist forks](/assets/images/help/gist/gist_forks.png)

-### Cloning gists
+## Cloning gists

 If you want to make local changes to a gist and push them up to the web, you can clone a gist and make commits the same as you would with any Git repository. For more information, see "[Cloning a repository](/articles/cloning-a-repository)."

 ![Gist clone button](/assets/images/help/gist/gist_clone_btn.png)

-### Viewing gist commit history
+## Viewing gist commit history

 To view a gist's full commit history, click the "Revisions" tab at the top of the gist{.

--- a/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md
+++ b/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md
@@ -15,13 +15,13 @@ We've added some custom functionality to create {% data variables.product.prodna

 You can also interact with other users in pull requests and issues using features like [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), [issue and PR references](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests), and [emoji](/articles/basic-writing-and-formatting-syntax/#using-emoji).

-### Text formatting toolbar
+## Text formatting toolbar

 Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, allowing you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @mentions, task lists, and links to issues and pull requests.

 ![Markdown toolbar](/assets/images/help/writing/markdown-toolbar.gif)

-### Further reading
+## Further reading

 - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
 - "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"
--- a/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
+++ b/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
@@ -9,7 +9,7 @@ versions:
  enterprise-server: '*'
  github-ae: '*'
 ---
-### Headings
+## Headings

 To create a heading, add one to six `#` symbols before your heading text. The number of `#` you use will determine the size of the heading.

@@ -21,7 +21,7 @@ To create a heading, add one to six `#` symbols before your heading text. The nu

 ![Rendered H1, H2, and H6 headings](/assets/images/help/writing/headings-rendered.png)

-### Styling text
+## Styling text

 You can indicate emphasis with bold, italic, or strikethrough text in comment fields and `.md` files.  

@@ -33,7 +33,7 @@ You can indicate emphasis with bold, italic, or strikethrough text in comment fi
 | Bold and nested italic | `** **` and `_ _` | | `**This text is _extremely_ important**` | **This text is _extremely_ important** |
 | All bold and italic | `*** ***` | | `***All this text is important***` | ***All this text is important*** |

-### Quoting text
+## Quoting text

 You can quote text with a `>`.

@@ -51,7 +51,7 @@ In the words of Abraham Lincoln:

 {% endtip %}

-### Quoting code
+## 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.

@@ -76,7 +76,7 @@ git commit

 For more information, see "[Creating and highlighting code blocks](/articles/creating-and-highlighting-code-blocks)."

-### Links
+## Links

 You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. You can also use the keyboard shortcut `command + k` to create a link.

@@ -90,15 +90,15 @@ You can create an inline link by wrapping link text in brackets `[ ]`, and then

 {% endtip %}

-### Section links
+## Section links

 {% data reusables.repositories.section-links %}

-### Relative links
+## Relative links

 {% data reusables.repositories.relative-links %}

-### Lists
+## Lists

 You can make an unordered list by preceding one or more lines of text with `-` or `*`.

@@ -120,7 +120,7 @@ To order your list, precede each line with a number.

 ![Rendered ordered list](/assets/images/help/writing/ordered-list-rendered.png)

-#### Nested Lists
+### Nested Lists

 You can create a nested list by indenting one or more list items below another item.

@@ -159,7 +159,7 @@ You can create multiple levels of nested lists using the same method. For exampl

 For more examples, see the [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#example-265).

-### Task lists
+## Task lists

 {% data reusables.repositories.task-list-markdown %}

@@ -169,7 +169,7 @@ If a task list item description begins with a parenthesis, you'll need to escape

 For more information, see "[About task lists](/articles/about-task-lists)."

-### Mentioning people and teams
+## 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 {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."

@@ -183,17 +183,17 @@ Typing an `@` symbol will bring up a list of people or teams on a project. The l

 The autocomplete results are restricted to repository collaborators and any other participants on the thread.

-### Referencing issues and pull requests
+## Referencing issues and pull requests

 You can bring up a list of suggested issues and pull requests within the repository by typing `#`. Type the issue or pull request number or title to filter the list, and then press either tab or enter to complete the highlighted result.

 For more information, see "[Autolinked references and URLs](/articles/autolinked-references-and-urls)."

-### Referencing external resources
+## Referencing external resources

 {% data reusables.repositories.autolink-references %}

-### Content attachments
+## Content attachments

 Some {% data variables.product.prodname_github_app %}s provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} renders the information provided by the app under the URL in the body or comment of an issue or pull request.

@@ -205,11 +205,11 @@ Content attachments will not be displayed for URLs that are part of a markdown l

 For more information about building a {% data variables.product.prodname_github_app %} that uses content attachments, see "[Using Content Attachments](/apps/using-content-attachments)."

-### Uploading assets
+## Uploading assets

 You can upload assets like images by dragging and dropping, selecting from a file browser, or pasting. You can upload assets to issues, pull requests, comments, and `.md` files in your repository.

-### Using emoji
+## Using emoji

 You can add emoji to your writing by typing `:EMOJICODE:`.

@@ -221,11 +221,11 @@ Typing `:` will bring up a list of suggested emoji. The list will filter as you

 For a full list of available emoji and codes, check out [the Emoji-Cheat-Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md).

-### Paragraphs
+## Paragraphs

 You can create a new paragraph by leaving a blank line between lines of text.

-### Ignoring Markdown formatting
+## Ignoring Markdown formatting

 You can tell {% data variables.product.product_name %} to ignore (or escape) Markdown formatting by using `\` before the Markdown character.

@@ -235,7 +235,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)."

-### Further reading
+## Further reading

 - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
 - "[About writing and formatting on GitHub](/articles/about-writing-and-formatting-on-github)"
--- a/content/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md
+++ b/content/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md
@@ -9,7 +9,7 @@ versions:
  enterprise-server: '*'
  github-ae: '*'
 ---
-### URLs
+## URLs

 {% data variables.product.product_name %} automatically creates links from standard URLs.

@@ -19,7 +19,7 @@ versions:

 For more information on creating links, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax/#links)."

-### Issues and pull requests
+## Issues and pull requests

 Within conversations on {% data variables.product.product_name %}, references to issues and pull requests are automatically converted to shortened links.

@@ -37,7 +37,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)

-### Commit SHAs
+## Commit SHAs

 References to a commit's SHA hash are automatically converted into shortened links to the commit on {% data variables.product.product_name %}.

@@ -48,10 +48,10 @@ References to a commit's SHA hash are automatically converted into shortened lin
 | User@SHA | jlord@a5c3785ed8d6a35868bc169f07e40e889087fd2e | [jlord@a5c3785](https://github.com/jlord/sheetsee.js/commit/a5c3785ed8d6a35868bc169f07e40e889087fd2e)
 | `Username/Repository@SHA` | `jlord/sheetsee.js@a5c3785ed8d6a35868bc169f07e40e889087fd2e` | [`jlord/sheetsee.js@a5c3785`](https://github.com/jlord/sheetsee.js/commit/a5c3785ed8d6a35868bc169f07e40e889087fd2e) |

-### Custom autolinks to external resources
+## Custom autolinks to external resources

 {% data reusables.repositories.autolink-references %}

-### Further reading
+## Further reading

 - "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"
--- a/content/github/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet.md
+++ b/content/github/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet.md
@@ -33,7 +33,7 @@ This type of permanent link will render as a code snippet only in the repository
 6. Paste your permalink into a comment, and click **Comment**.
  ![Pasted permalink in a comment in the same repository](/assets/images/help/repository/code-snippet-permalink-in-comment.png)

-### Further reading
+## Further reading

 - "[Creating an issue](/articles/creating-an-issue/)"
 - "[Opening an issue from code](/articles/opening-an-issue-from-code/)"
--- a/content/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md
+++ b/content/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md
@@ -10,7 +10,7 @@ versions:
  github-ae: "*"
 ---

-### Fenced code blocks
+## Fenced code blocks

 You can create fenced code blocks by placing triple backticks <code>\`\`\`</code> before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.

@@ -44,7 +44,7 @@ Look! You can see my backticks.
 ![Rendered fenced code with backticks block](/assets/images/help/writing/fenced-code-show-backticks-rendered.png)


-### Syntax highlighting
+## Syntax highlighting

 <!-- If you make changes to this feature, update /getting-started-with-github/github-language-support to reflect any changes to supported languages. -->

@@ -62,7 +62,7 @@ For example, to syntax highlight Ruby code:

 We use [Linguist](https://github.com/github/linguist) to perform language detection and to select [third-party grammars](https://github.com/github/linguist/blob/master/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).

-### Further reading
+## Further reading

 - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
 - "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"
--- a/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables.md
+++ b/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables.md
@@ -9,7 +9,7 @@ versions:
  enterprise-server: '*'
  github-ae: '*'
 ---
-### Creating a table
+## Creating a table

 You can create tables with pipes `|` and hyphens `-`. Hyphens are used to create each column's header, while pipes separate each column. You must include a blank line before your table in order for it to correctly render.

@@ -36,7 +36,7 @@ Cells can vary in width and do not need to be perfectly aligned within columns.

 ![Rendered table with varied cell width](/assets/images/help/writing/table-varied-columns-rendered.png)

-### Formatting content within your table
+## Formatting content within your table

 You can use [formatting](/articles/basic-writing-and-formatting-syntax) such as links, inline code blocks, and text styling within your table:

@@ -71,7 +71,7 @@ To include a pipe `|` as content within your cell, use a `\` before the pipe:

 ![Rendered table with an escaped pipe](/assets/images/help/writing/table-escaped-character-rendered.png)

-### Further reading
+## Further reading

 - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
 - "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"
--- a/content/github/writing-on-github/working-with-saved-replies/about-saved-replies.md
+++ b/content/github/writing-on-github/working-with-saved-replies/about-saved-replies.md
@@ -19,7 +19,7 @@ You can create a maximum of 100 saved replies. If you've reached the maximum lim

 You can also use the {% data variables.product.product_name %}-provided "Duplicate issue" saved reply to mark an issue as a duplicate and track it with a similar issue.

-### Further reading
+## Further reading

 - "[Creating a saved reply](/articles/creating-a-saved-reply)"
 - "[Using saved replies](/articles/using-saved-replies)"
--- a/content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md
+++ b/content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md
@@ -20,7 +20,7 @@ versions:
 6. Click **Add saved reply**.
 ![Add a saved reply](/assets/images/help/settings/saved-replies-add-button.png)

-### Further reading
+## Further reading

 - "[Using saved replies](/articles/using-saved-replies)"
 - "[Editing a saved reply](/articles/editing-a-saved-reply)"
--- a/content/github/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md
+++ b/content/github/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md
@@ -19,7 +19,7 @@ versions:
 5. Click **Update saved reply**.
 ![Update saved reply](/assets/images/help/settings/saved-replies-save-edit.png)

-### Further reading
+## Further reading

 - "[Creating a saved reply](/articles/creating-a-saved-reply)"
 - "[Deleting a saved reply](/articles/deleting-a-saved-reply)"
--- a/content/github/writing-on-github/working-with-saved-replies/using-saved-replies.md
+++ b/content/github/writing-on-github/working-with-saved-replies/using-saved-replies.md
@@ -25,7 +25,7 @@ versions:

 {% endtip %}

-### Further reading
+## Further reading

 - "[Creating a saved reply](/articles/creating-a-saved-reply)"
 - "[Editing a saved reply](/articles/editing-a-saved-reply)"