From 25de8aae831d26adfbb656e8d54b543593865f06 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Fri, 16 Sep 2022 11:12:47 -0700 Subject: [PATCH] note cases where em tag won't work (#30707) Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- contributing/content-markup-reference.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/contributing/content-markup-reference.md b/contributing/content-markup-reference.md index c6408fe9b4..198d3f3a15 100644 --- a/contributing/content-markup-reference.md +++ b/contributing/content-markup-reference.md @@ -72,7 +72,7 @@ To render syntax highlighting in command line instructions, we use triple backti This syntax highlighting renders light text on a dark background, and should be reserved for command line instructions. -Within the command-line syntax, you can also use the `` helper tag to indicate content that varies for each user, such as a user or repository name. +Within the command-line syntax, you can also use the `` helper tag to indicate content that varies for each user, such as a user or repository name. **Note**: If you specify a language other than `sh` or `shell` or you use `{:copy}`, the `` tag will not render correctly. **Copy-able code blocks** @@ -82,6 +82,9 @@ You can also add a header that includes the name of the language and a button to const copyMe = true ``` +**Note**: The `` tag will not render correctly with the `copy` button. + + ## Octicons Octicons are icons used across GitHub’s interface. We reference Octicons when documenting the user interface. Find the name of the Octicon on the [Octicons site](https://primer.style/octicons). For accessibility purposes, use [the `aria-label` option](https://primer.style/octicons/packages/javascript#aria-label) to describe the Octicon.