From 2eb1694871e3b4e1eb6c61480db236de6a42f79a Mon Sep 17 00:00:00 2001 From: Dana Ottaviani Date: Tue, 5 Feb 2019 07:04:18 -0500 Subject: [PATCH] Feat/add guide for writing solutions (#35041) * feat: add guide for writing challenge solution * feat: fix markdown for solution example * fix: add requested changes for formatting solution --- docs/style-guide-for-curriculum-challenges.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/style-guide-for-curriculum-challenges.md b/docs/style-guide-for-curriculum-challenges.md index 1496703335..e611499128 100644 --- a/docs/style-guide-for-curriculum-challenges.md +++ b/docs/style-guide-for-curriculum-challenges.md @@ -18,6 +18,7 @@ With that practical focus in mind, let’s talk about the requirements for our c - [Writing instructions](#writing-instructions) - [Formatting challenge text](#formatting-challenge-text) - [Formatting seed code](#formatting-seed-code) +- [Formatting solution](#formatting-solution) - [Why do we have all these rules?](#why-do-we-have-all-these-rules) ## Proper nouns @@ -139,6 +140,40 @@ Here are specific formatting guidelines for the challenge seed code: `// Fix this line` +## Formatting Solution + +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 + [ SOLUTION CODE] +three backticks + +
+``` + +Example: + +```` +
+ +```html + + +
+

Hello World!

+
+``` + +
+```` + ## Why do we have all these rules? Our goal is to develop a fun and clear interactive learning experience.