Skip to content

Commit

Permalink
refine first sentences in example markdown and challenges
Browse files Browse the repository at this point in the history
  • Loading branch information
pgrunde committed Sep 22, 2023
1 parent 9290a41 commit 991a5fd
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Markdown Examples

Lessons are written in markdown. You can see a bunch of examples of markdown syntax in this file.
Lessons are written in markdown. You can see a number of examples of markdown syntax in this file.

You can view a complete list of available Learn custom markdown elements by running `learn md` and looking under the 'Other Markdown' section.

File headers can be written to define attributes for the content file itself, which are under the 'Files' section.

# H1 Top-Level Heading

Galvanize is committed to creating opportunities for Veterans to gain the skills and knowledge they need to enter the tech industry after service to their country. As Veterans Day approaches, we’ll be chronicling the stories…

## H2 Next-Level Heading

At Galvanize, we’re putting a whole new spin on Study Hall with monthly, members-only sessions. At every Study Hall, industry all-stars present on one of three topics –– growth, funding, or product –– and collaborate…
At Galvanize, we’re putting a whole new spin on Study Hall with monthly sessions. At every Study Hall, industry all-stars present on one of three topics –– growth, funding, or product –– and collaborate…

### H3 Next-Level Heading

Expand Down
38 changes: 23 additions & 15 deletions app/cmd/embeds/walkthrough/01-example-unit/02-challenges.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Interactive questions called "challenges" can be added to any markdown lesson to check for understanding. These same challenges can also be used to construct practice assignments, quizzes, and assessments.

## Examples of Each Type
You can view a complete list of available challenge types by running `learn md` and looking under the 'Questions' section.

## Examples of Types

* multiple choice (select one)
* checkbox (select multiple)
Expand All @@ -13,7 +15,6 @@ Interactive questions called "challenges" can be added to any markdown lesson to
* project, testable project (code locally, submit a repo)



## Multiple Choice

Multiple Choice challenges allow a student to submit a single answer to a multiple-choice question.
Expand All @@ -34,31 +35,37 @@ Multiple Choice challenges allow a student to submit a single answer to a multip

### !question

Which of these cities is home to a Galvanize campus?
In which of these U.S. cities could you travel directly North, South, East, or West until you left the state, and arrive in the same new state no matter which direction you chose?

### !end-question

<!--'options' is required, a bulleted markdown list, the options the student selects the correct answer from-->

### !options

* Chicago
* Denver
* Fort Collins
* Miami
a| Wheeling, West Virginia
b| Dover, Delaware
c| Stamford, Connecticut
d| Jacksonville, Florida

### !end-options

<!--'answer' is required, the correct answer, must exist in the options-->

### !answer

Denver
c|

### !end-answer

<!--'explanation' is optional. Shown after the student correctly answers the question.-->

### !explanation

If you headed in any of the four directions you would still end up in New York, with East being the most surprising as you'd first pass over ocean until you ended up in Long Island.

### !end-explanation

### !end-challenge

<!----------------------END CHALLENGE----------------------------->
Expand All @@ -80,23 +87,24 @@ Checkbox challenges allow a student to submit multiple answers to a multiple-cho

##### !question

Mark all of the cities that are home to a Galvanize campus.
Mark all of the ingredients in a peanut butter and jelly sandwich.

##### !end-question

##### !options

* Portland
* Denver
* Los Angeles
* Miami
* Peanut Butter
* Coleslaw
* Jelly
* Bread

##### !end-options

##### !answer

* Denver
* Los Angeles
* Peanut Butter
* Jelly
* Bread

##### !end-answer

Expand Down
1 change: 1 addition & 0 deletions app/cmd/markdown.go
Original file line number Diff line number Diff line change
Expand Up @@ -1623,6 +1623,7 @@ const uploadTemplateMin = `### !challenge

const distributeCodeTemplate = `<!-- Replace everything in square brackets [] and remove brackets -->
<!-- This button can be added anywhere except inside of a challenge -->
<!-- This can only be used with a single student repository model cohort. -->
### !distribute-code
* student_folder_path: [text, GitLab folder path that code will be distributed to in student's cohort repo URL (can be blank)]
Expand Down

0 comments on commit 991a5fd

Please sign in to comment.