README.md

kuiz.md

🎯 Live demo at https://kuiz-md.firebaseapp.com

You can use the kuiz NPM module to generate your own kuiz from Markdown you provide.

npm install kuiz-md

Or, if you use yarn:

yarn add kuiz-md

Usage

Provide:

• your markdown text
• a callback triggered when an user sends the kuiz
• a HTML element to render the kuiz into

const app = require('kuiz-md');

const markdown = '# your *Markdown* text _here_';
const yourCallback = (data) => {
  alert('User ' + data.email + ' had grade ' + data.grade);
};
const elementIdToRenderInto = "my-kuiz"

app.init(markdown, yourCallback, elementIdToRenderInto);

Special notation

There is a special notation for handling the Kuiz possible responses:

Multiple possible answers

The user must validate all possible answers, identifed with a "x" inside the parenthesis:

random text

( ) answer not valid
(x) answer valid
(x) answer valid
( ) answer not valid

Other answer types: WIP

Development

To launch a local webserver, run

npm start

Deployment

npm run deploy