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
pull/36179/head
leodaher 2019-06-05 04:17:40 -03:00 committed by Oliver Eyton-Williams
parent f70bcce463
commit 93bfd479e7
1 changed files with 18 additions and 3 deletions

View File

@ -123,9 +123,24 @@ Here are specific formatting guidelines for challenge text and examples:
- Language keywords go in `<code>` 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 `<dfn>` tags
- Single line code examples go in `<code>` tags
- Multi-line code examples go in `<blockquote>` tags, and use the `<br>` tag to separate lines. For HTML examples, remember to use escape characters to represent the angle brackets
- A single horizontal rules (`<hr>` 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 `<code>` tags. See example below:
````
Use <code>parseInt</code> to convert the variable <code>realNumber</code> 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 `<strong>Note:</strong> Rest of note text...`
- Use double quotes where applicable