Skip to content

Commit 02539cc

Browse files
ethanpalmsarahs
andauthored
Add info on <pre> tags to markdown reference and style guide (#35111)
Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com>
1 parent 545a80b commit 02539cc

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

contributing/content-markup-reference.md

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

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

77-
Within the command-line syntax, use all uppercase text to indicate placeholder text or content that varies for each user, such as a user or repository name.
77+
Within the command-line syntax, use all uppercase text to indicate placeholder text or content that varies for each user, such as a user or repository name. By default, codeblocks will escape the content within the triple backticks. If you need to write sample code that parses the content (for example, to italicize text within `<em>` tags instead of passing the tags through literally), wrap the codeblock in `<pre>` `</pre>` tags.
7878

7979
**Copy-able code blocks**
8080

contributing/content-style-guide.md

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Within code blocks:
4949
- Do not use markup before the command output.
5050
- Only use `$` before the command itself if you’re showing the command’s output in the same block.
5151
- If your code example includes `{` or `}` that should render, wrap that section in `{% raw %}` `{% endraw %}` to disable Liquid processing for that section.
52+
- If your code example includes content that should be parsed (for example, HTML tags to format text), wrap that section in `<pre>` `</pre>` tags to parse rather than escape the content in the section.
5253
- **Use**:
5354

5455
```

0 commit comments

Comments
 (0)