This repository provides an mdBook preprocessor that allows you to add interactive quizzes to your Markdown books. A quiz looks like this:
Table of contents: * Installation + From crates.io + From source * Usage * Quiz schema + Short answer + Multiple choice + Tracing * Quiz configuration
These instructions assume you have an mdBook already set up. Unfamiliar with mdBook? Read the mdBook guide!
cargo install mdbook-quiz
Note: this tool is under active development. I recommend pinning to a specific version to avoid breakage, e.g. by running
cargo install mdbook-quiz --version <YOUR_VERSION>
And you can check your version by running mdbook-quiz -V. This repository uses semantic versioning for the quiz data format, so your quizzes should not break if you update to a more recent patch.
You need Cargo and pnpm installed. Then run:
git clone https://github.com/willcrichton/mdbook-quiz
cd mdbook-quiz
cargo install --path .
First, create a quiz file. Quizzes are encoded as TOML files (see Quiz schema). For example:
```toml
[[questions]]
type = "ShortAnswer"
prompt.prompt = "What is the keyword for declaring a variable in Rust?"
answer.answer = "let"
context = "For example, you can write: let x = 1"
```
Then in your Markdown file, add a reference to the quiz file:
```markdown
And now, a quiz:
{{#quiz ../quizzes/rust-variables.toml}} ```
Configure your book.toml to activate mdbook-quiz.
```toml
[preprocessor.quiz] ```
Then mdbook build should correctly embed the quiz.
Note: due to limitations of mdBook (see mdBook#1087), the
mdbook-quizpreprocessor will copy files into your book's source directory under a subdirectory namedmdbook-quiz. I recommend adding this directory to your.gitignore.
A quiz is an array of questions.
ts
export interface Quiz {
questions: Question[];
}
A question is one of a set of predefined question types.
ts
export type Question = ShortAnswer | Tracing | MultipleChoice;
Each question type is an instantiation of this Typescript interface:
ts
export interface QuestionFields<Type extends string, Prompt, Answer> {
type: Type;
prompt: Prompt;
answer: Answer;
context?: Markdown;
}
It has a discriminating string name type and then a prompt and answer, along with additional context for explaining the answer.
Note that the
Markdowntype is just a string, but will be interpreted as Markdown by the quiz renderer.
Currently, mdbook-quiz supports these question types: * Short answer * Multiple choice * Tracing
A question where the answer is a one-line string.
toml
[[questions]]
type = "ShortAnswer"
prompt.prompt = "What is the keyword for declaring a variable in Rust?"
answer.answer = "let"
context = "For example, you can write: `let x = 1`"
```ts export interface ShortAnswerPrompt { /** The text of the prompt. */ prompt: Markdown; }
export interface ShortAnswerAnswer { /** The exact string that answers the question. */ answer: string;
/** Other acceptable strings answers. */ alternatives?: string[]; }
export type ShortAnswer = QuestionFields<"ShortAnswer", ShortAnswerPrompt, ShortAnswerAnswer>; ```
A question with multiple options that the user selects from.
toml
[[questions]]
type = "MultipleChoice"
prompt.prompt = "What does it mean if a variable `x` is immutable?"
prompt.choices = [
"`x` is stored in the immutable region of memory.",
"After being defined, `x` can be changed at most once.",
"`x` cannot be changed after being assigned to a value.",
"You cannot create a reference to `x`."
]
answer.answer = 2
context = """
Immutable means "not mutable", or not changeable.
"""
```ts export interface MultipleChoicePrompt { /** The text of the prompt. */ prompt: Markdown;
/** An array of text explaining each choice. */ choices: Markdown[]; }
export interface MultipleChoiceAnswer { /** The index of the correct answer in the choices array (0-based). */ answer: number; } ```
A question where the user has to predict how a program will execute (or fail to compile).
toml
[[questions]]
type = "Tracing"
prompt.program = """
fn main() {
let x = 1;
println!("{x}");
x += 1;
println!("{x}");
}
"""
answer.doesCompile = false
answer.lineNumber = 4
context = """
This is a compiler error because line 4 tries to mutate `x` when `x` is not marked as `mut`.
"""
```ts export interface TracingPrompt { /** The contents of the program to trace */ program: string; }
export interface TracingAnswer { /** True if the program should pass the compiler */ doesCompile: boolean;
/** If doesCompile=true, then the contents of stdout after running the program */ stdout?: string;
/** If doesCompile=false, then the line number of the code causing the error */ lineNumber?: number; }
export type Tracing = QuestionFields<"Tracing", TracingPrompt, TracingAnswer>; ```
You can configure mdbook-quiz by adding options to the [preprocessor.quiz] section of book.toml. The options are:
validate (boolean): If true, then mdbook-quiz will validate your quiz TOML files using the validator.js script installed with mdbook-quiz. You must have NodeJS installed on your machine and PATH for this to work.fullscreen (boolean): If true, then a quiz will take up the web page's full screen during use.cache-answers (boolean): If true, then the user's answers will be saved in their browser's localStorage. Then the quiz will show the user's answers even after they reload the page.