From 3b8cce87e16ac40f4019b0431741d32729458776 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Mon, 15 Apr 2024 11:53:32 -0400 Subject: [PATCH 1/2] Upgrade Primer (#50120) --- package-lock.json | 84 ++++++++++++++++++++++++++--------------------- package.json | 8 ++--- 2 files changed, 51 insertions(+), 41 deletions(-) diff --git a/package-lock.json b/package-lock.json index d157b6978ce8..4a120eae6f5e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,11 +12,11 @@ "@github/failbot": "0.8.3", "@octokit/plugin-retry": "6.0.1", "@octokit/request-error": "5.0.1", - "@primer/behaviors": "^1.3.5", + "@primer/behaviors": "^1.5.1", "@primer/css": "^21.2.2", - "@primer/octicons": "^19.5.0", - "@primer/octicons-react": "^19.5.0", - "@primer/react": "36.2.0", + "@primer/octicons": "^19.9.0", + "@primer/octicons-react": "^19.9.0", + "@primer/react": "36.13.0", "accept-language-parser": "^1.5.0", "ajv": "^8.11.0", "ajv-errors": "^3.0.0", @@ -2719,8 +2719,14 @@ } }, "node_modules/@lit-labs/react": { - "version": "1.1.1", - "license": "BSD-3-Clause" + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@lit-labs/react/-/react-1.2.1.tgz", + "integrity": "sha512-DiZdJYFU0tBbdQkfwwRSwYyI/mcWkg3sWesKRsHUd4G+NekTmmeq9fzsurvcKTNVa0comNljwtg4Hvi1ds3V+A==" + }, + "node_modules/@lit-labs/ssr-dom-shim": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@lit-labs/ssr-dom-shim/-/ssr-dom-shim-1.2.0.tgz", + "integrity": "sha512-yWJKmpGE6lUURKAaIltoPIE/wrbY3TEkqQt+X0m+7fQNnAv0keydnYvbiJFP1PnMhizmIWRWOG5KLhYyc/xl+g==" }, "node_modules/@next/env": { "version": "14.1.4", @@ -3092,9 +3098,9 @@ } }, "node_modules/@primer/behaviors": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/@primer/behaviors/-/behaviors-1.3.5.tgz", - "integrity": "sha512-HWwz+6MrfK5NTWcg9GdKFpMBW/yrAV937oXiw2eDtsd88P3SRwoCt6ZO6QmKp9RP3nDU9cbqmuGZ0xBh0eIFeg==" + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/@primer/behaviors/-/behaviors-1.5.1.tgz", + "integrity": "sha512-ApPbNhiWPHscs0+rLV76sCY75IEpPvDEZq9+iQXQqU6Tv5SLdax3PmzJlUHftlQ7O/eJnLO1dTEMEwj2Yn1BLA==" }, "node_modules/@primer/css": { "version": "21.2.2", @@ -3108,18 +3114,26 @@ "node": ">=16.0.0" } }, + "node_modules/@primer/live-region-element": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@primer/live-region-element/-/live-region-element-0.2.0.tgz", + "integrity": "sha512-3zE1ipoMMxdmAkgB49dX+CIVpIXCGQGYwq5EF4kUIcMLjE4nAUOWkEMlcTCrDAlvfrv71YRx+h+AjRX70urLRg==", + "dependencies": { + "@lit-labs/ssr-dom-shim": "^1.2.0" + } + }, "node_modules/@primer/octicons": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@primer/octicons/-/octicons-19.5.0.tgz", - "integrity": "sha512-b3IBp3EmzLc/YMw3xdqy7Lg8CgFObYaWegPntoKO1bZLZ4sAG5PRMPp36rj4TF1sDHbNufhGMvdCCM5VdS3mPQ==", + "version": "19.9.0", + "resolved": "https://registry.npmjs.org/@primer/octicons/-/octicons-19.9.0.tgz", + "integrity": "sha512-uAZa9cMgWkzbEsZnYWB7tg0vt7QprubD7ljtprz2fBJ8CjyqoxFRRsFvH4UiJdjK/3o87ODgDkhiflyJXDh+Lg==", "dependencies": { "object-assign": "^4.1.1" } }, "node_modules/@primer/octicons-react": { - "version": "19.8.0", - "resolved": "https://registry.npmjs.org/@primer/octicons-react/-/octicons-react-19.8.0.tgz", - "integrity": "sha512-2Z+D7xTloFTLQVRUEbg0pQpe6aTL9RR+8RqBhjkrF+BFuVdM1ENOyjywaGEO7DIkPU5Zxlv0gxSlD85LQxL+sw==", + "version": "19.9.0", + "resolved": "https://registry.npmjs.org/@primer/octicons-react/-/octicons-react-19.9.0.tgz", + "integrity": "sha512-Uk4XrHyfylyfzZN9d8VFjF8FpfYHEyT4sabw+9+oP+GWAJHhPvNPTz6gXvUzJZmoblAvgcTrDslIPjz8zMh76w==", "engines": { "node": ">=8" }, @@ -3133,20 +3147,21 @@ "integrity": "sha512-K9fPgKVBtdmBMl+lHKUK4ctsRf+DUUKdJYEHnFhkua71m9FORK16ycJ4gHDpc4g/0xgNvEwQ9/ArsV1i8w3ZmQ==" }, "node_modules/@primer/react": { - "version": "36.2.0", - "resolved": "https://registry.npmjs.org/@primer/react/-/react-36.2.0.tgz", - "integrity": "sha512-rLt9C+Yf1mbNxsuwhYFC3W0gi/8iagkfZ1YSeJC64jOUBqOGYY1YBAejE+3E1Hup9MaEkrFS4WLBT2rpzeqVNw==", + "version": "36.13.0", + "resolved": "https://registry.npmjs.org/@primer/react/-/react-36.13.0.tgz", + "integrity": "sha512-SBpqU+jTTGF2ezOKjA9R+7+zlxYlaO/VgchMzSBlXT5DooGM0/FD+t/njTavyl4KNrZyFkVU1Q/SrsiYQTmmVg==", "dependencies": { "@github/combobox-nav": "^2.1.5", "@github/markdown-toolbar-element": "^2.1.0", "@github/paste-markdown": "^1.4.0", "@github/relative-time-element": "^4.1.2", - "@lit-labs/react": "^1.1.1", + "@github/tab-container-element": "4.5.0", + "@lit-labs/react": "1.2.1", "@oddbird/popover-polyfill": "^0.3.1", - "@primer/behaviors": "^1.3.4", - "@primer/octicons-react": "^19.8.0", - "@primer/primitives": "^7.11.11", - "@react-aria/ssr": "^3.5.0", + "@primer/behaviors": "^1.5.1", + "@primer/live-region-element": "^0.2.0", + "@primer/octicons-react": "^19.9.0", + "@primer/primitives": "^7.15.14", "@styled-system/css": "^5.1.5", "@styled-system/props": "^5.1.5", "@styled-system/theme-get": "^5.1.2", @@ -3155,7 +3170,7 @@ "@types/styled-system__css": "^5.0.16", "@types/styled-system__theme-get": "^5.0.1", "clsx": "^1.2.1", - "color2k": "^2.0.0", + "color2k": "^2.0.3", "deepmerge": "^4.2.2", "focus-visible": "^5.2.0", "fzy.js": "^0.4.1", @@ -3191,6 +3206,11 @@ } } }, + "node_modules/@primer/react/node_modules/@github/tab-container-element": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/@github/tab-container-element/-/tab-container-element-4.5.0.tgz", + "integrity": "sha512-8pzFJVg7AyPFqOjKFoiHwVQbo4MdTPpUfQwW91Hgj+OOvySZVmw4PU8ejU4qTHbb2oA2ajYMRuXuAvhfMgnS1Q==" + }, "node_modules/@primer/react/node_modules/@oddbird/popover-polyfill": { "version": "0.3.7", "resolved": "https://registry.npmjs.org/@oddbird/popover-polyfill/-/popover-polyfill-0.3.7.tgz", @@ -3214,17 +3234,6 @@ "@primer/behaviors": "^1.3.4" } }, - "node_modules/@react-aria/ssr": { - "version": "3.7.0", - "resolved": "https://registry.npmjs.org/@react-aria/ssr/-/ssr-3.7.0.tgz", - "integrity": "sha512-bfufjg4ESE5giN+Fxj1XIzS5f/YIhqcGc+Ve+vUUKU8xZ8t/Xtjlv8F3kjqDBQdk//n3mluFY7xG1wQVB9rMLQ==", - "dependencies": { - "@swc/helpers": "^0.5.0" - }, - "peerDependencies": { - "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0" - } - }, "node_modules/@sideway/address": { "version": "4.1.4", "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.4.tgz", @@ -5068,8 +5077,9 @@ } }, "node_modules/color2k": { - "version": "2.0.2", - "license": "MIT" + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/color2k/-/color2k-2.0.3.tgz", + "integrity": "sha512-zW190nQTIoXcGCaU08DvVNFTmQhUpnJfVuAKfWqUQkflXKpaDdpaYoM0iluLS9lgJNHyBF58KKA2FBEwkD7wog==" }, "node_modules/colorette": { "version": "2.0.20", diff --git a/package.json b/package.json index 74cecf5ae24b..3f6228036fc2 100644 --- a/package.json +++ b/package.json @@ -237,11 +237,11 @@ "@github/failbot": "0.8.3", "@octokit/plugin-retry": "6.0.1", "@octokit/request-error": "5.0.1", - "@primer/behaviors": "^1.3.5", + "@primer/behaviors": "^1.5.1", "@primer/css": "^21.2.2", - "@primer/octicons": "^19.5.0", - "@primer/octicons-react": "^19.5.0", - "@primer/react": "36.2.0", + "@primer/octicons": "^19.9.0", + "@primer/octicons-react": "^19.9.0", + "@primer/react": "36.13.0", "accept-language-parser": "^1.5.0", "ajv": "^8.11.0", "ajv-errors": "^3.0.0", From d246b92764544f134209cff7eb76a3b9325108b3 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 15 Apr 2024 17:18:30 +0100 Subject: [PATCH 2/2] Update contributing doc to match style guide (#50139) --- ...sing-markdown-and-liquid-in-github-docs.md | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md index 8e2df335d7a8..bcfca8cfc86d 100644 --- a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -50,27 +50,29 @@ This content is displayed on the {% data variables.product.prodname_docs %} site ## Callout tags -Callouts highlight important information that users need to know. We use standard formatting and colors for different types of callouts: notes, warnings, and danger notices. Use Liquid tags before and after the text you’d like included in the callout box. +Callouts highlight important information that users need to know. We use standard formatting and colors for four different types of callouts: notes, tips, warnings, and danger notices. -For information on when to use callout tags, see "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#callouts)." +For information on when to use callouts, and how to format them in Markdown, see "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#callouts)." -### Example usage of a callout +### Examples of callouts ```markdown -{% raw %}{% note %} - -**Note:** Owners and administrators can add outside collaborators to a repository. - -{% endnote %}{% endraw %} +> [!NOTE] Keep this in mind. ``` -### Example callout rendered on {% data variables.product.prodname_docs %} - -{% note %} +```markdown +> [!NOTE] +> Generally callouts should be short. +> +> But occasionally may require more than one paragraph +``` -**Note:** Owners and administrators can add outside collaborators to a repository. +### Example callouts rendered on {% data variables.product.prodname_docs %} -{% endnote %} +> [!NOTE] +> Generally callouts should be short. +> +> But occasionally may require more than one paragraph ## Code sample syntax highlighting