From 93bfd479e79532660599e6731ec3a9a4729683b9 Mon Sep 17 00:00:00 2001 From: leodaher Date: Wed, 5 Jun 2019 04:17:40 -0300 Subject: [PATCH] fix(guide): Update Challenges Style Guide to recommend triple backticks instead of blockquote (#36069) * Update challenges style guide to recommend triple backticks * fix: removed outdated part regarding hr element --- docs/style-guide-for-curriculum-challenges.md | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/style-guide-for-curriculum-challenges.md b/docs/style-guide-for-curriculum-challenges.md index 3172838442..c50d142a7c 100644 --- a/docs/style-guide-for-curriculum-challenges.md +++ b/docs/style-guide-for-curriculum-challenges.md @@ -123,9 +123,24 @@ Here are specific formatting guidelines for challenge text and examples: - Language keywords go in `` tags. For example, HTML tag names or CSS property names - The first instance of a keyword when it's being defined, or general keywords (i.e. "object" or "immutable") go in `` tags -- Single line code examples go in `` tags -- Multi-line code examples go in `
` tags, and use the `
` tag to separate lines. For HTML examples, remember to use escape characters to represent the angle brackets -- A single horizontal rules (`
` tag) should separate the text discussing the challenge concept and the challenge instructions +- References to code parts (i.e. function, method or variable names) should be wrapped in `` tags. See example below: + +```` +Use parseInt to convert the variable realNumber into an integer. +```` +- Multi-line code blocks **must be preceded by an empty line**. The next line must start with three backticks followed immediately by one of the [supported languages](https://prismjs.com/#supported-languages). To complete the code block, you must start a newline which only has three backticks and **another empty line**. +**Note:** If you are going to use an example code in YAML, use `yaml` instead of `yml` for the language to the right of the backticks. +See example below: +```` +The following is an example of code: + +```{language} + +[YOUR CODE HERE] + +``` + +```` - Additional information in the form of a note should be formatted `Note: Rest of note text...` - Use double quotes where applicable