Skip to content

Commit fe214ec

Browse files
authored
Add guidance on how to style variable text in code blocks (#30869)
1 parent a710373 commit fe214ec

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

contributing/content-markup-reference.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ To render syntax highlighting in command line instructions, we use triple backti
6767
### Usage
6868

6969
```shell
70-
git init <em>YOUR_REPO</em>
70+
git init YOUR_REPO
7171
```
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. **Note**: If you specify a language other than `sh` or `shell` or you use `{:copy}`, the `<em>` tag will not render correctly.
75+
Within the command-line syntax, use all uppercase text to indicate content that varies for each user, such as a user or repository name.
7676

7777
**Copy-able code blocks**
7878

@@ -82,9 +82,6 @@ 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-
8885
## Octicons
8986

9087
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)