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.2.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: canvas-markdown-quiz-0.2.2.tar.gz
  • Upload date:
  • Size: 6.5 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.2.tar.gz
Algorithm Hash digest
SHA256 a44b2e754e0d4610387cf9c6002ef3c487b9e86728b4f22bc13d55fd56660eac
MD5 f02e5308895acaa6575c6523eef79571
BLAKE2b-256 62259f100af72409e9db290e50f4b80fc8de7d7af5272910d5080a2d48d73a44

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for canvas_markdown_quiz-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9d7727090cdf8d6fbe008df271528ec51683d614ee674819344ff8957003b909
MD5 48142299fdcd659ab847a502e899dc9c
BLAKE2b-256 7b147fa733571ae5cfcd6fa5cdcc0cafca091f65de2fcfba617b7c22eaeae26e

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