diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md index 7cb074b04c0d..415fdd8de958 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md @@ -66,6 +66,9 @@ This will display the code block with syntax highlighting: ![Screenshot of three lines of Ruby code as displayed on {% data variables.product.prodname_dotcom %}. Elements of the code display in purple, blue, and red type for scannability.](/assets/images/help/writing/code-block-syntax-highlighting-rendered.png) +> [!TIP] +> When you create a fenced code block that you also want to have syntax highlighting on a GitHub Pages site, use lower-case language identifiers. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#syntax-highlighting). + We use [Linguist](https://github.com/github-linguist/linguist) to perform language detection and to select [third-party grammars](https://github.com/github-linguist/linguist/blob/main/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml). ## Creating diagrams diff --git a/content/organizations/managing-programmatic-access-to-your-organization/viewing-api-insights-in-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/viewing-api-insights-in-your-organization.md index d2216a4685be..e69d4bd55091 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/viewing-api-insights-in-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/viewing-api-insights-in-your-organization.md @@ -12,8 +12,6 @@ topics: - REST --- -> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. We welcome your feedback in [this {% data variables.product.prodname_github_community %} discussion](https://github.co/api-insights-discussion). - ## About API insights As a {% data variables.product.prodname_ghe_cloud %} organization owner, you and your designated users can view REST API activity for your entire organization or specific apps and users. This helps you understand the sources of your REST API activity and manage against your primary rate limits, giving you visibility into the timeframe, apps, and API endpoints involved. To learn more about primary rate limits, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-primary-rate-limits). diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 81f38ce1acd7..da923660e358 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -110,6 +110,9 @@ To make your site easier to read, code snippets are highlighted on {% data varia By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/rouge-ruby/rouge) highlighter (which is compatible with [Pygments](https://pygments.org/)). If you specify Pygments in your `_config.yml` file, Rouge will be used as the fallback instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your `_config.yml` file. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites). +> [!NOTE] +> Rouge only recognizes lower-case language identifiers for fenced code blocks. For a list of supported languages, see [Languages](https://rouge-ruby.github.io/docs/file.Languages.html). + If you want to use another highlighter, such as [highlight.js](https://github.com/highlightjs/highlight.js), you must disable Jekyll's syntax highlighting by updating your project's `_config.yml` file. ```yaml diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md index 643ae0254f4b..9309fe1181fe 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md @@ -76,7 +76,7 @@ jobs: - name: Setup Node.js uses: {% data reusables.actions.action-setup-node %} with: - node-version: '18.x' + node-version: '20.x' # This step installs the octokit library. The script that this workflow will run uses the octokit library. - name: Install dependencies @@ -98,18 +98,18 @@ jobs: WORKFLOW_REPO: {% raw %}${{ github.event.repository.name }}{% endraw %} WORKFLOW_REPO_OWNER: {% raw %}${{ github.repository_owner }}{% endraw %} run: | - node .github/workflows/scripts/redeliver-failed-deliveries.js + node .github/workflows/scripts/redeliver-failed-deliveries.mjs ``` ## Adding the script This section demonstrates how you can write a script to find and redeliver failed deliveries. -Copy this script into a file called `.github/workflows/scripts/redeliver-failed-deliveries.js` in the same repository where you saved the {% data variables.product.prodname_actions %} workflow file above. +Copy this script into a file called `.github/workflows/scripts/redeliver-failed-deliveries.mjs` in the same repository where you saved the {% data variables.product.prodname_actions %} workflow file above. ```javascript copy annotate // This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)." -const { App, Octokit } = require("octokit"); +import { App, Octokit } from "octokit"; // async function checkAndRedeliverWebhooks() { diff --git a/data/reusables/actions/branch-requirement.md b/data/reusables/actions/branch-requirement.md index 1c5755893233..4bc2eb84d36d 100644 --- a/data/reusables/actions/branch-requirement.md +++ b/data/reusables/actions/branch-requirement.md @@ -1,2 +1,2 @@ > [!NOTE] -> This event will only trigger a workflow run if the workflow file is on the default branch. +> This event will only trigger a workflow run if the workflow file exists on the default branch.