Anatomy of a Markdown file#

TODO: add an image and overview here!

Question Body#

After the YAML header is complete, the next section contains the question text, and this is what the students will be able to see.

Part X Section in the markdown file#

This section will include your question in sentences for the question that you are authoring. You should keep the following in mind while filling this section in:

  • Keep each sentence on a separate line.

  • Use markdown syntax for any variables you use from the Python code section. Eg: {{ params.vars.varName }}

  • Use latex syntax for any units or symbols that you might use.

All the data used in this section should be stored in the data2 dictionary as seen in the server section of the header.

Answer Section in the markdown file#

This section will include the answer(s) for your question. There may be different number of answers depending upon the type of the question you will be authoring. It will always be a three level ### header in the markdown file. Each part of the question should have an answer section.

Rubric Section in the markdown file#

This is not a required section, but would be used to give the grader a rubric to use for grading a tricky question.

Solution Section in the markdown file#

This section is primarily for the questions that do not have a simple answer. Multi-sentence answers or questions that have elaborate explanations that cannot be coded in should use this section to explain how these questions should be graded.

This is not a required section, and is hidden from the students.

Comments Section in the markdown file#

This is for any comments related to the question that you might want to include. This is not a required section, and is hidden from the students.