MiczFlor / quicz-means-quiz-markdown

QUICZ is a very simple format for creating multiple choice questions based on markdown syntax with clear human-readability in mind. Repo comes with conversion scripts.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Easy creation of LMS learning material

QUICZ is a very simple format for creating multiple choice questions based on markdown syntax with clear human-readability in mind. Repo comes with conversion scripts.

QUICZ aims to allow anyone to:

  • create learning material
  • while you are learning
  • with minimal distraction
  • in plain text

QUICZ goals are to:

  • stick to the basics
  • be useful and readable in plain text
  • provide conversion to multiple standards and platforms

The name QUICZ comes from 'quiz'.

How did it start?

I came up with the the quicz format when I was in need of learning a lot and learning it fast. While ploughing through the material, I wanted to simultanously generate learning content like multiple choice questions on the fly to use them later in Moodle LMS or other learning management system or flashcard software.

Over the years, I have defaulted to markdown for most of my writing and note taking. I find it easy and intuitive to write. One thing lead to another and I merged my immediate need with my comfort zone.

Simple example explained

Here is an example of a valid multiple choice question in the quicz format:

> QUICZ is a very simple format for creating 
multiple choice questions with clear 
human-readability in mind. What syntax is it 
inspired by and based on?

+ markdown
- python
- html 

(The correct answers is 'markdown')

In markdown syntax:

  • the question is a blockquote
  • all possible answers are an unordered list.

In a list, if you use '+' the following content is correct. Anything following a '-' bullet is incorrect.

For more detailed information, visit the docs folder.

About

QUICZ is a very simple format for creating multiple choice questions based on markdown syntax with clear human-readability in mind. Repo comes with conversion scripts.

License:MIT License


Languages

Language:Python 99.5%Language:Shell 0.5%