Skip to main content

Markdown support for canvas quiz

Project description

Canvas-markdown-quiz

Add markdown support for Canvas LMS quizzes.

Features

  • Markdown parsing
  • Latex Rendering (using Upmath as backend)
  • One markdown file per quiz

Quick Start

Markdown Writing

Following test.md, create your own quiz markdown file, like quiz1.md.

The structure of this md file should be like this:

---
(Some quiz configs)
---

# Your Title

(Your description)

---

(Block 1)

---

(Block 2)

---

...

---

(Block n)

Quiz config should be formatted as YAML, and the options are available at this page. You don't have to set title and description parameter in this config.


Each block is a question, and it should be like this:

---

```yaml
question_type: multiple_choice_question
points_possible: 1
answers:
    -
        answer_text: "Option 1"
        answer_weight: 100
    -
        answer_text: "Option 2"
        answer_weight: 0
```

Question description goes here.

```cpp
#include <stdio.h>

int main(){
    printf("Hello World!");
}
```
---

Quiz question config should be formatted as YAML, and the options are available at this page. You don't have to set the text parameter in this config.

Installation

  1. Install canvas-markdown-quiz
# using pip for python
pip install canvas-markdown-quiz

# using pip3 for python3
pip3 install canvas-markdown-quiz
  1. Run command

Open your project directory, and type the following command to run.

For the first time, it will ask you some questions to save the configuration file.

cvs-makequiz <md filename>

Snapshot

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canvas-markdown-quiz-0.2.1.tar.gz (153.2 kB view details)

Uploaded Source

Built Distribution

canvas_markdown_quiz-0.2.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file canvas-markdown-quiz-0.2.1.tar.gz.

File metadata

  • Download URL: canvas-markdown-quiz-0.2.1.tar.gz
  • Upload date:
  • Size: 153.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for canvas-markdown-quiz-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5828c64f43db6a535c195ea79971ab4da038c30862cbe0ab4eb8a10da30b526f
MD5 00bec7547283ab3456f307a2dd0905a2
BLAKE2b-256 e9d9defd81cc4a0ef6e16188267e8a3568f7447cedef838f69188e875d6b5557

See more details on using hashes here.

File details

Details for the file canvas_markdown_quiz-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for canvas_markdown_quiz-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83538b5f5df155935d4c3d13629901a2bfa299f8fc8c55d7516954420d0518b9
MD5 f8de9036842639f0e9592d0a08e9002d
BLAKE2b-256 9578cd1e83d4b366502629622e16d20257d3157bca5ce8fa81331a79b2e0b5a4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page