From ff15832ccd2982fc9ff8b26322dc00ee8f19ef04 Mon Sep 17 00:00:00 2001 From: Oliver Eyton-Williams Date: Mon, 29 Apr 2019 15:32:56 +0200 Subject: [PATCH] fix: Update challenge docs with new note guidelines (#35929) --- docs/style-guide-for-curriculum-challenges.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/style-guide-for-curriculum-challenges.md b/docs/style-guide-for-curriculum-challenges.md index a379d82808..3172838442 100644 --- a/docs/style-guide-for-curriculum-challenges.md +++ b/docs/style-guide-for-curriculum-challenges.md @@ -126,7 +126,7 @@ Here are specific formatting guidelines for challenge text and examples: - 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 -- Additional information in the form of a note should be formatted `Note
Rest of note text...` +- Additional information in the form of a note should be formatted `Note: Rest of note text...` - Use double quotes where applicable ## Formatting seed code @@ -144,15 +144,15 @@ Here are specific formatting guidelines for the challenge seed code: The challenge solution must be in proper markdown tags. The code must be wrapped in `section` tags with an id of `solution`. -``` +````
-three backticks + html or js +```html or ```js [ SOLUTION CODE] -three backticks +```
-``` +```` Example: