Skip to content

Commit 25de8aa

Browse files
note cases where em tag won't work (#30707)
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent fb6156f commit 25de8aa

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

contributing/content-markup-reference.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To render syntax highlighting in command line instructions, we use triple backti
7272

7373
This syntax highlighting renders light text on a dark background, and should be reserved for command line instructions.
7474

75-
Within the command-line syntax, you can also use the `<em>` helper tag to indicate content that varies for each user, such as a user or repository name.
75+
Within the command-line syntax, you can also use the `<em>` 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 `<em>` tag will not render correctly.
7676

7777
**Copy-able code blocks**
7878

@@ -82,6 +82,9 @@ You can also add a header that includes the name of the language and a button to
8282
const copyMe = true
8383
```
8484

85+
**Note**: The `<em>` tag will not render correctly with the `copy` button.
86+
87+
8588
## Octicons
8689

8790
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.

0 commit comments

Comments
 (0)