From 02539ccfb4c312cdec02ee985f7ff9f40f8a1184 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 27 Feb 2023 13:24:58 -0800 Subject: [PATCH] Add info on `
` tags to markdown reference and style
 guide (#35111)

Co-authored-by: Sarah Schneider 
---
 contributing/content-markup-reference.md | 2 +-
 contributing/content-style-guide.md      | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/contributing/content-markup-reference.md b/contributing/content-markup-reference.md
index e93b8abfaa..febbbcdcba 100644
--- a/contributing/content-markup-reference.md
+++ b/contributing/content-markup-reference.md
@@ -74,7 +74,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, use all uppercase text to indicate placeholder text or content that varies for each user, such as a user or repository name.
+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 `` tags instead of passing the tags through literally), wrap the codeblock in `
` `
` tags. **Copy-able code blocks** diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 6ec072a991..1b2e73b5b2 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -49,6 +49,7 @@ Within code blocks: - Do not use markup before the command output. - Only use `$` before the command itself if you’re showing the command’s output in the same block. - If your code example includes `{` or `}` that should render, wrap that section in `{% raw %}` `{% endraw %}` to disable Liquid processing for that section. +- If your code example includes content that should be parsed (for example, HTML tags to format text), wrap that section in `
` `
` tags to parse rather than escape the content in the section. - **Use**: ```