Skip to content

Commit 2df2cdb

Browse files
authored
fix commonmark issues (github#42054)
1 parent 757be76 commit 2df2cdb

File tree

17 files changed

+78
-81
lines changed

17 files changed

+78
-81
lines changed

content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ product: '{% data reusables.gated-features.merge-queue %}'
3939

4040
![Screenshot of the merge queue options for a pull request.](/assets/images/help/pull_requests/merge-queue-options.png)
4141

42-
{% note %}
42+
{% note %}
4343

44-
**Note:** You can click **Merge when ready** whenever you're ready to merge your proposed changes. {% data variables.product.product_name %} will automatically add the pull request to the merge queue once required approval and status checks conditions are met.
44+
**Note:** You can click **Merge when ready** whenever you're ready to merge your proposed changes. {% data variables.product.product_name %} will automatically add the pull request to the merge queue once required approval and status checks conditions are met.
4545

46-
{% endnote %}
46+
{% endnote %}
4747

4848
1. Confirm you want to add the pull request to the merge queue by clicking **Confirm merge when ready**.
4949

content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u
4949

5050
- [Merge all of the commits into the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) by clicking **Merge pull request**. If the **Merge pull request** option is not shown, click the merge dropdown menu and select **Create a merge commit**.
5151

52-
![Screenshot of the merge options for a pull request. The arrow to expand the dropdown is outlined in dark orange.](/assets/images/help/pull_requests/merge-pull-request-options.png)
52+
![Screenshot of the merge options for a pull request. The arrow to expand the dropdown is outlined in dark orange.](/assets/images/help/pull_requests/merge-pull-request-options.png)
5353

5454
- [Squash the commits into one commit](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Squash and merge** and then clicking **Squash and merge**.
5555

content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ The summary list of methods and functions is created from these supported file t
3333

3434
1. Select the changed function or method from the drop-down menu. You can also enter the name of the function or method to filter results.
3535

36-
{% note %}
36+
{% note %}
3737

38-
**Note:** If you don't see the functions or methods you expected, confirm that your code compiles and doesn't contain errors. Only functions and methods changed in this pull request and found in _.go_, _.js_, _.ts_, _.py_, _.php_, and _.rb_ files appear in the drop-down menu.
38+
**Note:** If you don't see the functions or methods you expected, confirm that your code compiles and doesn't contain errors. Only functions and methods changed in this pull request and found in _.go_, _.js_, _.ts_, _.py_, _.php_, and _.rb_ files appear in the drop-down menu.
3939

40-
{% endnote %}
40+
{% endnote %}
4141

4242
1. You'll be redirected to the first line of the function or method you selected.
4343

content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ You can configure the {% data variables.dependency-review.action_name %} to bett
5353
![Screenshot of the "Changed files" tab. A dropdown labeled "File filter" is expanded, displaying a list of file types with checkboxes.](/assets/images/help/pull_requests/file-filter-menu-json.png)
5454
The dependency review provides a clearer view of what has changed in large lock files, where the source diff is not rendered by default.
5555

56-
{% note %}
56+
{% note %}
5757

5858
**Note:** Dependency review rich diffs are not available for committed static JavaScript files like `jquery.js`.
5959

6060
{% endnote %}
6161

6262
1. On the right of the header for a manifest or lock file, display the dependency review by clicking **{% octicon "file" aria-label="Display the rich diff" %}**.
6363

64-
![Screenshot of the "Files changed" tab of a pull request. The button to display the rich diff, labeled with a file icon, is outlined in dark orange.](/assets/images/help/pull_requests/dependency-review-rich-diff.png)
64+
![Screenshot of the "Files changed" tab of a pull request. The button to display the rich diff, labeled with a file icon, is outlined in dark orange.](/assets/images/help/pull_requests/dependency-review-rich-diff.png)
6565

6666
1. Check the dependencies listed in the dependency review.
6767

content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Organizations can use the `name@organization.com` email as a public point of con
3737
>
3838
```
3939
40-
{% tip %}
40+
{% tip %}
4141
42-
**Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer.
42+
**Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer.
4343
44-
{% endtip %}
44+
{% endtip %}
4545
4646
1. On the next line of the commit message, type `on-behalf-of: @org <name@organization.com>`, then a closing quotation mark.
4747

content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,23 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
4242

4343
1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines.
4444

45-
```
45+
```shell
4646
$ git commit -m "Refactor usability tests.
4747
>
4848
>
4949
```
5050
51-
{% tip %}
51+
{% tip %}
5252
53-
**Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `Co-authored-by:` commit trailer.
53+
**Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `Co-authored-by:` commit trailer.
5454
55-
{% endtip %}
55+
{% endtip %}
5656
5757
1. On the next line of the commit message, type `Co-authored-by: name <name@example.com>` with specific information for each co-author. After the co-author information, add a closing quotation mark.
5858
5959
If you're adding multiple co-authors, give each co-author their own line and `Co-authored-by:` commit trailer. Do not add blank lines between each co-author line.
6060
61-
```
61+
```shell
6262
$ git commit -m "Refactor usability tests.
6363
>
6464
>

content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ shortTitle: Install Git LFS
1616
{% mac %}
1717

1818
1. Navigate to [git-lfs.github.com](https://git-lfs.github.com) and click **Download**. Alternatively, you can install {% data variables.large_files.product_name_short %} using a package manager:
19-
- To use [Homebrew](https://brew.sh/), run `brew install git-lfs`.
20-
- To use [MacPorts](https://www.macports.org/), run `port install git-lfs`.
19+
- To use [Homebrew](https://brew.sh/), run `brew install git-lfs`.
20+
- To use [MacPorts](https://www.macports.org/), run `port install git-lfs`.
2121

22-
If you install {% data variables.large_files.product_name_short %} with Homebrew or MacPorts, skip to step six.
22+
If you install {% data variables.large_files.product_name_short %} with Homebrew or MacPorts, skip to step six.
2323

2424
1. On your computer, locate and unzip the downloaded file.
2525
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -61,11 +61,11 @@ shortTitle: Install Git LFS
6161

6262
1. Navigate to [git-lfs.github.com](https://git-lfs.github.com) and click **Download**.
6363

64-
{% tip %}
64+
{% tip %}
6565

66-
**Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Windows, see this [Getting started guide](https://github.com/github/git-lfs#getting-started).
66+
**Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Windows, see this [Getting started guide](https://github.com/github/git-lfs#getting-started).
6767

68-
{% endtip %}
68+
{% endtip %}
6969
1. On your computer, locate the downloaded file.
7070
1. Double click on the file called _git-lfs-windows-1.X.X.exe_, where 1.X.X is replaced with the Git LFS version you downloaded. When you open this file Windows will run a setup wizard to install {% data variables.large_files.product_name_short %}.
7171
{% data reusables.command_line.open_the_multi_os_terminal %}
@@ -84,11 +84,11 @@ shortTitle: Install Git LFS
8484

8585
1. Navigate to [git-lfs.github.com](https://git-lfs.github.com) and click **Download**.
8686

87-
{% tip %}
87+
{% tip %}
8888

89-
**Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Linux, see this [Getting started guide](https://github.com/github/git-lfs#getting-started).
89+
**Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Linux, see this [Getting started guide](https://github.com/github/git-lfs#getting-started).
9090

91-
{% endtip %}
91+
{% endtip %}
9292
1. On your computer, locate and unzip the downloaded file.
9393
{% data reusables.command_line.open_the_multi_os_terminal %}
9494
1. Change the current working directory into the folder you downloaded and unzipped.

content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ shortTitle: Remove files
1717
1. Remove the file from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)."
1818
1. Navigate to your _.gitattributes_ file.
1919

20-
{% note %}
20+
{% note %}
2121

22-
**Note:** Your _.gitattributes_ file is generally saved within your local repository. In some cases, you may have created a global _.gitattributes_ file that contains all of your {% data variables.large_files.product_name_short %} associations.
22+
**Note:** Your _.gitattributes_ file is generally saved within your local repository. In some cases, you may have created a global _.gitattributes_ file that contains all of your {% data variables.large_files.product_name_short %} associations.
2323

24-
{% endnote %}
24+
{% endnote %}
2525
1. Find and remove the associated {% data variables.large_files.product_name_short %} tracking rule within the _.gitattributes_ file.
2626
1. Save and exit the _.gitattributes_ file.
2727

content/repositories/working-with-files/using-files/navigating-code-on-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Symbol search is a feature of code search. For more information, see "[AUTOTITLE
6262
1. Select a repository, then navigate to a file containing symbols.
6363
1. To bring up the symbols pane, above the file content, click {% octicon "code-square" aria-label="The code square icon" %}.
6464

65-
Alternatively, you can open the symbols pane by clicking an eligible symbol in your file. Clickable symbols are highlighted in yellow when you hover over them.
65+
Alternatively, you can open the symbols pane by clicking an eligible symbol in your file. Clickable symbols are highlighted in yellow when you hover over them.
6666

6767
1. Click the symbol you would like to find from the symbols pane or within the file itself.
6868

content/rest/quickstart.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app %
8282
1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example:
8383

8484
```yaml
85-
86-
{% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=1 %}
85+
{% data reusables.actions.actions-not-certified-by-github-comment %}
8786
8887
on:
8988
workflow_dispatch:
@@ -97,13 +96,11 @@ If you are authenticating with a {% data variables.product.prodname_github_app %
9796
with:
9897
app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %}
9998
private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %}
100-
10199
- name: Use API
102100
env:
103101
GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %}
104102
run: |
105103
gh api repos/octocat/Spoon-Knife/issues
106-
107104
```
108105

109106
{% endcli %}
@@ -230,7 +227,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app %
230227

231228
```yaml
232229

233-
{% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=1 %}
230+
{% data reusables.actions.actions-not-certified-by-github-comment %}
234231

235232
on:
236233
workflow_dispatch:
@@ -359,7 +356,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app %
359356

360357
```yaml
361358
362-
{% indented_data_reference reusables.actions.actions-not-certified-by-github-comment spaces=1 %}
359+
{% data reusables.actions.actions-not-certified-by-github-comment %}
363360
364361
on:
365362
workflow_dispatch:

0 commit comments

Comments
 (0)