Add example quiz and publish on CI

.github/workflows/main.yml

@@ -17,3 +17,11 @@ jobs:
       # so we don't need to run pnpm build here.
       - run: pnpm test && pnpm lint
         working-directory: js
+      - run: cargo install --path . --debug --locked
+      - run: mdbook build
+        working-directory: example
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./example/book
+

example/.gitignore

@@ -0,0 +1,2 @@
+book
+src/mdbook-quiz

example/book.toml

@@ -0,0 +1,8 @@
+[book]
+authors = ["Will Crichton"]
+language = "en"
+multilingual = false
+src = "src"
+title = "example"
+
+[preprocessor.quiz]

example/src/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+- [Chapter 1](./chapter_1.md)

example/src/chapter_1.md

@@ -0,0 +1,5 @@
+# Chapter 1
+
+Here's a *quiz!*
+
+{{#quiz ./quiz.toml}}

example/src/quiz.toml

@@ -0,0 +1,37 @@
+[[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.
+"""
+
+[[questions]]
+type = "ShortAnswer"
+prompt.prompt = "What is the keyword used after `let` to indicate that a variable can be mutated?"
+answer.answer = "mut"
+context = """
+For example, you can make a mutable variable `x` by writing: `let mut x = 1`.
+"""
+
+[[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`.
+"""