From b8bd4630f6e057d98870e93f6e41d733bf983b3f Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Mon, 25 Sep 2023 11:21:53 -0700 Subject: [PATCH] fix incorrect code language case --- .../creating-a-docker-container-action.md | 2 +- .../about-actions-runner-controller.md | 2 +- .../introduction-to-dev-containers.md | 2 +- ...k-creation-and-resumption-of-codespaces.md | 4 +-- .../syntax-for-githubs-form-schema.md | 10 +++---- .../syntax-for-issue-forms.md | 2 +- .../creating-a-local-environment.md | 2 +- .../using-videos-in-github-docs.md | 2 +- .../syntax-for-discussion-category-forms.md | 2 +- .../quickstart-for-writing-on-github.md | 20 ++++++------- .../receiving-webhooks-with-the-github-cli.md | 6 ++-- contributing/development.md | 2 +- contributing/node-versions.md | 10 +++---- contributing/videos.md | 2 +- .../reusables/community/issue-forms-sample.md | 2 +- .../discussion-category-forms-sample.md | 2 +- .../picture-element-example.md | 2 +- tests/PLAYWRIGHT.md | 28 +++++++++---------- tests/README.md | 18 ++++++------ tests/fixtures/README.md | 6 ++-- .../content/get-started/liquid/raw.md | 2 +- 21 files changed, 64 insertions(+), 64 deletions(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index d24275bfcdc3..87f719e60ee8 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -42,7 +42,7 @@ In your new `hello-world-docker-action` directory, create a new `Dockerfile` fil **Dockerfile** -```Dockerfile copy +```dockerfile copy # Container image that runs your code FROM alpine:3.10 diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller.md index 59ee27eccc5e..36701458578a 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller.md @@ -113,7 +113,7 @@ You can create your own runner image that meets your requirements. Your runner i You can use the following example Dockerfile to start creating your own runner image. -```Dockerfile copy +```dockerfile copy FROM mcr.microsoft.com/dotnet/runtime-deps:6.0 as build # Replace value with the latest runner release version diff --git a/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md index 6d7eaa06a494..b5619e5a86f5 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md @@ -83,7 +83,7 @@ The following example uses four instructions: `RUN` updates package lists and runs a script. You can also use a `RUN` instruction to install software, as shown by the commented out instructions. To run multiple commands, use `&&` to combine the commands into a single `RUN` statement. -```Dockerfile copy +```dockerfile copy ARG VARIANT="16-buster" FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces.md index 0569fdd55c95..281e3fbfae14 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces.md @@ -90,13 +90,13 @@ This type of URL is useful, for instance, in a README for your repository as it 1. Get the URL to the codespace creation page, or the "Resume codespace" page, as described in the previous sections. 1. Add the following Markdown to, for example, the `README.md` file of your repository: - ```Markdown copy + ```markdown copy [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](URL) ``` For example: - ```Markdown + ```markdown [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/github/docs) ``` diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md index 49ba54e7dbf5..435727d38947 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -99,7 +99,7 @@ For multi-line text, you can use the pipe operator. #### Example of `markdown` -```YAML copy +```yaml copy body: - type: markdown attributes: @@ -136,7 +136,7 @@ You can use a `textarea` element to add a multi-line text field to your form. Co #### Example of `textarea` -```YAML copy +```yaml copy body: - type: textarea id: repro @@ -178,7 +178,7 @@ You can use an `input` element to add a single-line text field to your form. #### Example of `input` -```YAML copy +```yaml copy body: - type: input id: prevalence @@ -216,7 +216,7 @@ You can use a `dropdown` element to add a dropdown menu in your form. #### Example of `dropdown` -```YAML copy +```yaml copy body: - type: dropdown id: download @@ -259,7 +259,7 @@ You can use the `checkboxes` element to add a set of checkboxes to your form. #### Example of `checkboxes` -```YAML copy +```yaml copy body: - type: checkboxes id: operating-systems diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md index a82e60af3dde..226efbd7bbc7 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md @@ -31,7 +31,7 @@ This example YAML configuration file defines an issue form using several inputs All issue form configuration files must begin with `name`, `description`, and `body` key-value pairs. -```YAML copy +```yaml copy name: description: body: diff --git a/content/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md b/content/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md index f46f6ee7f588..7bfcb177569c 100644 --- a/content/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md +++ b/content/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md @@ -43,7 +43,7 @@ If you're using `nodenv`, see the [`nodenv` docs](https://github.com/nodenv/node Once you've installed Node.js (which includes the popular `npm` package manager), open your terminal and run the following commands. -```sh +```shell git clone https://github.com/github/docs cd docs npm ci diff --git a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md index 4e9a933d82dd..f2cde75ce034 100644 --- a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md @@ -136,7 +136,7 @@ Add a link to the article with a video's transcript in the description of the vi In any content with an embedded video, add a `product_video_transcript` property below the `product_video` property in the YAML frontmatter. The value of `product_video_transcript` is a link to the transcript article in the `video-transcripts` directory. -```YAML +```yaml title: Example product landing page product_video: 'https://www.youtube-nocookie.com/embed/URL' product_video_transcript: /content/video-transcripts/TRANSCRIPT-TITLE diff --git a/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md b/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md index 7daacf6a13a6..5339e8c7288c 100644 --- a/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md +++ b/content/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms.md @@ -24,7 +24,7 @@ This example YAML configuration file defines a general discussion category form. The configuration file for a discussion category form must contain a `body` key, and the `body` must contain at least 1 non-Markdown field. -```YAML copy +```yaml copy body: - type: input id: suggestion diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md index 29dc9cd995f1..6a3bf0e6b540 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md @@ -61,7 +61,7 @@ By using the HTML `` element with the `prefers-color-scheme` media feat 1. Copy and paste the following markup into your {% ifversion ghae %}`about-me.md`{% else %}`README.md`{% endif %} file. - ```HTML copy + ```html copy @@ -94,7 +94,7 @@ You can use Markdown tables to organize information. Here, you'll use a table to 1. Return to the **Edit {% ifversion ghae %}new {% endif %}file** tab. 1. To introduce yourself, two lines below the `` tag, add an `## About me` header and a short paragraph about yourself, like the following. - ```Markdown + ```markdown ## About me Hi, I'm Mona. You might recognize me as {% data variables.product.prodname_dotcom %}'s mascot. @@ -102,7 +102,7 @@ You can use Markdown tables to organize information. Here, you'll use a table to 1. Two lines below this paragraph, insert a table by copying and pasting the following markup. - ```Markdown copy + ```markdown copy | Rank | THING-TO-RANK | |-----:|---------------| | 1| | @@ -117,7 +117,7 @@ For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-wi ### Example of a table -```Markdown +```markdown ## About me Hi, I'm Mona. You might recognize me as {% data variables.product.prodname_dotcom %}'s mascot. @@ -139,7 +139,7 @@ To keep your content tidy, you can use the `
` tag to create an expandib 1. To create a collapsed section for the table you created, wrap your table in `
` tags like in the following example. - ```HTML copy + ```html copy
My top THINGS-TO-RANK @@ -151,7 +151,7 @@ To keep your content tidy, you can use the `
` tag to create an expandib 1. Between the `` tags, replace `THINGS-TO-RANK` with whatever you ranked in your table. 1. Optionally, to make the section display as open by default, add the `open` attribute to the `
` tag. - ```HTML + ```html
``` @@ -159,7 +159,7 @@ To keep your content tidy, you can use the `
` tag to create an expandib ### Example of a collapsed section -```HTML +```html
My top languages @@ -182,13 +182,13 @@ Markdown has many other options for formatting your content. Here, you'll add a 1. At the bottom of your file, two lines below the `
` tag, add a horizontal rule by typing three or more dashes. - ```Markdown + ```markdown --- ``` 1. Below the `---` line, add a quote by typing markup like the following. - ```Markdown + ```markdown > QUOTE ``` @@ -197,7 +197,7 @@ Markdown has many other options for formatting your content. Here, you'll add a ### Example of a quote -```Markdown +```markdown --- > If we pull together and commit ourselves, then we can push through anything. diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/receiving-webhooks-with-the-github-cli.md b/content/webhooks/testing-and-troubleshooting-webhooks/receiving-webhooks-with-the-github-cli.md index 8b67b2bb9159..dcead762bf97 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/receiving-webhooks-with-the-github-cli.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/receiving-webhooks-with-the-github-cli.md @@ -30,13 +30,13 @@ Webhook forwarding in the {% data variables.product.prodname_cli %} only works w 1. To install the {% data variables.product.prodname_cli %} extension to enable webhook forwarding, use the `extension install` subcommand. - ```sh + ```shell gh extension install cli/gh-webhook ``` 1. If you want to forward organization webhooks, add the `admin:org_hook` scope to your {% data variables.product.prodname_cli %} login so you have the required permissions. - ```sh + ```shell gh auth refresh --scopes admin:org_hook ``` @@ -44,7 +44,7 @@ Webhook forwarding in the {% data variables.product.prodname_cli %} only works w 1. To set up webhooks to be delivered to your application, run the `webhook forward` subcommand. Replace `REPOSITORY` with the name of your repository. For example, `monalisa/octocat`. Replace `EVENTS` with a comma-separated list of the events that you want to receive. For example, `issues,pull_request`. Replace `URL` with the local URL where your application expects to receive webhooks. For example, `"http://localhost:3000/webhook"`. To listen for organization webhooks instead of repository webhooks, replace the `--repo` flag with the `--org` flag. For example `--org="octo-org"`. - ```sh + ```shell gh webhook forward --repo=REPOSITORY --events=EVENTS --url=URL ``` diff --git a/contributing/development.md b/contributing/development.md index 8b09c30c3dd2..839aeb1508fd 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -12,7 +12,7 @@ You'll need Node.js to run the site. Check the version in `package.json`. To ins Once you've installed Node.js (which includes the popular `npm` package manager), open Terminal and run the following: -```sh +```shell git clone https://github.com/github/docs cd docs npm ci diff --git a/contributing/node-versions.md b/contributing/node-versions.md index 0c6d14a3fb67..39c7223b33b9 100644 --- a/contributing/node-versions.md +++ b/contributing/node-versions.md @@ -16,13 +16,13 @@ When updating to a new Node.js version, consider the following files: If you're using macOS, run this command to get the latest: -```sh +```shell brew upgrade nodenv node-build ``` If you see a warning like this one, run the suggested command: -```sh +```shell # You should change the ownership of these directories to your user. sudo chown -R $(whoami) /usr/local/sbin ``` @@ -31,19 +31,19 @@ If you're using another operating system, or did not use Homebrew to install nod To install Node.js and make it your default version, run this command: -```sh +```shell # Set VERSION= based on package.json#engines nodenv install $VERSION && nodenv global $VERSION ``` You may sometimes see a warning when running npm scripts with nodenv: -```sh +```shell npm WARN lifecycle The node binary used for scripts is [...] but npm is using [...] ``` This is due to nodenv's overriding behavior. To silence this harmless warning, the [nodenv docs](https://github.com/nodenv/nodenv/wiki/FAQ#npm-warning-about-mismatched-binaries) recommend running the following command from any directory: -```sh +```shell npm config set scripts-prepend-node-path auto ``` diff --git a/contributing/videos.md b/contributing/videos.md index fe3e8aa4a1f2..58747263b5e0 100644 --- a/contributing/videos.md +++ b/contributing/videos.md @@ -126,7 +126,7 @@ Add a link to the article with a video's transcript in the description of the vi In any content with an embedded video, add a `product_video_transcript` property below the `product_video` property in the YAML frontmatter. The value of `product_video_transcript` is a link to the transcript article in the `video-transcripts` directory. -```YAML +```yaml title: Example product landing page product_video: 'https://www.youtube-nocookie.com/embed/URL' product_video_transcript: /content/video-transcripts/TRANSCRIPT-TITLE diff --git a/data/reusables/community/issue-forms-sample.md b/data/reusables/community/issue-forms-sample.md index a72f44d5b89e..9e9d34f4f599 100644 --- a/data/reusables/community/issue-forms-sample.md +++ b/data/reusables/community/issue-forms-sample.md @@ -1,4 +1,4 @@ -```YAML copy +```yaml copy name: Bug Report description: File a bug report title: "[Bug]: " diff --git a/data/reusables/discussions/discussion-category-forms-sample.md b/data/reusables/discussions/discussion-category-forms-sample.md index 31f71b2c71a7..25c9f79f9e39 100644 --- a/data/reusables/discussions/discussion-category-forms-sample.md +++ b/data/reusables/discussions/discussion-category-forms-sample.md @@ -1,4 +1,4 @@ -```YAML copy +```yaml copy title: "[General] " labels: ["General Introduction"] body: diff --git a/data/reusables/getting-started/picture-element-example.md b/data/reusables/getting-started/picture-element-example.md index 1fd23eae1438..904fbe5193b1 100644 --- a/data/reusables/getting-started/picture-element-example.md +++ b/data/reusables/getting-started/picture-element-example.md @@ -1,4 +1,4 @@ -```HTML +```html diff --git a/tests/PLAYWRIGHT.md b/tests/PLAYWRIGHT.md index ee596f3b118e..359ca3ae6303 100644 --- a/tests/PLAYWRIGHT.md +++ b/tests/PLAYWRIGHT.md @@ -10,13 +10,13 @@ There are currently 3 general automated tests: Just like with regular `jest` tests, if you haven't already done so... -```sh +```shell npm run build ``` Now, to run all the tests: -```sh +```shell npm run playwright-test ``` @@ -82,32 +82,32 @@ browser window will appear when tests run. The most basic command is: -```sh +```shell npm run playwright-test -- --help ``` This will guide you to all the options possible. For example, -```sh +```shell npm run playwright-test -- --headed ``` ...will open a browser flickering through the tests. -```sh +```shell npm run playwright-test -- playwright-rendering.spec.ts ``` ...will only run the tests in a file by that name. -```sh +```shell npm run playwright-test -- playwright-rendering.spec.ts:16 ``` ...will run that specific `test('description here', async ({ page }))` on line 16. -```sh +```shell npm run playwright-test -- -g "view home page" ``` @@ -121,13 +121,13 @@ browsers aren't up-to-date. In VSCode you might get this error: -```sh +```shell Browser was not installed. Invoke 'Install Playwright Browsers' action to install missing browsers. ``` On the CLI you might get this: -```sh +```shell Error: browserType.launch: Executable doesn't exist at /Users/peterbe/Library/Caches/ms-playwright/webkit-1848/pw_run.sh ╔═════════════════════════════════════════════════════════════════════════╗ ║ Looks like Playwright Test or Playwright was just installed or updated. ║ @@ -141,7 +141,7 @@ On the CLI you might get this: All you have to do is run: -```sh +```shell npx playwright install ``` @@ -156,7 +156,7 @@ The first thing to do is familiarize yourself with how to run the CLI that only opens the one specific test you're debugging. Then, you run the CLI with `--debug --headed`. For example: -```sh +```shell npm run playwright-test -- -g "view home page" --debug --headed ``` @@ -168,7 +168,7 @@ to understand what's in the DOM. Another thing that can help debugging is to open the browser just like the script does. Run: -```sh +```shell npm run start-for-playwright ``` @@ -183,13 +183,13 @@ debugger window it generates TypeScript code which you can copy-and-paste into your editor/IDE when you're done. To use codegen you need to first manually start the server. In the **first terminal**: -```sh +```shell npm run build && npm run start-for-playwright ``` In a **second terminal**: -```sh +```shell npx playwright codegen ``` diff --git a/tests/README.md b/tests/README.md index 4b0407c6d788..bc40ea7de352 100644 --- a/tests/README.md +++ b/tests/README.md @@ -16,7 +16,7 @@ We typically rely on CI to run our tests, so some large test-only dependencies are considered **optional**. To run the tests locally, you'll need to make sure optional dependencies are installed by running: -```sh +```shell npm ci --include=optional ``` @@ -25,7 +25,7 @@ npm ci --include=optional Once you've followed the development instructions above, you can run the entire test suite locally: -```sh +```shell script/test # or `npm test` ``` @@ -36,7 +36,7 @@ re-runs the tests whenever a change is made. This command notifies you when tests change to and from a passing or failing state, and it prints out a test coverage report so you can see what files need testing. -```sh +```shell npm run test-watch ``` @@ -44,7 +44,7 @@ npm run test-watch You can run specific tests in two ways: -```sh +```shell # The TEST_NAME can be a filename, partial filename, or path to a file or directory npm test -- @@ -59,7 +59,7 @@ If the tests fail locally with an error like this: You may need to run this before every test run: -```sh +```shell npx next build ``` @@ -68,7 +68,7 @@ npx next build To validate all your JavaScript code (and auto-format some easily reparable mistakes), run the linter: -```sh +```shell npm run lint ``` @@ -83,13 +83,13 @@ since the server won't need to start and stop every time you run tests. In one terminal, type: -```sh +```shell NODE_ENV=test PORT=4000 node server.js ``` In another terminal, type: -```sh +```shell START_JEST_SERVER=false jest tests/rendering/foo/bar.js ``` @@ -107,7 +107,7 @@ a page to throw a 500 Internal Server Error response. If you don't expect that and you might struggle to see exactly where the error is happening, set `$DEBUG_MIDDLEWARE_TESTS` to `true`. For example: -```sh +```shell export DEBUG_MIDDLEWARE_TESTS=true jest tests/rendering/ -b ``` diff --git a/tests/fixtures/README.md b/tests/fixtures/README.md index 299a4048574c..bbea36157669 100644 --- a/tests/fixtures/README.md +++ b/tests/fixtures/README.md @@ -35,7 +35,7 @@ you want it to be. Once you've found a place to put some fixture content, before writing a `jest` test, you can preview your changes using: -```sh +```shell npm run fixture-dev ``` @@ -52,7 +52,7 @@ about end-to-end testing a new custom Liquid tag called To run the tests use: -```sh +```shell ROOT=tests/fixtures jest tests/rendering-fixtures/ ``` @@ -72,7 +72,7 @@ so its translation repos copies can be translated. There's a script you can always run that makes sure all and any of these files are up to do: -```sh +```shell ./script/copy-fixture-data.js ``` diff --git a/tests/fixtures/content/get-started/liquid/raw.md b/tests/fixtures/content/get-started/liquid/raw.md index b009172b5b34..1991d97b66d0 100644 --- a/tests/fixtures/content/get-started/liquid/raw.md +++ b/tests/fixtures/content/get-started/liquid/raw.md @@ -13,7 +13,7 @@ type: how_to {% raw %} -```sh +```shell {% data foo.bar.buzz %} {{ page.title }} ```