exercises

README

Interactive exercises in a gitbook

With this plugin, a book can contain interactive exercises (currently only in Javascript). An exercise is a code challenge provided to the reader, who is given a code editor to write a solution which is checked against the book author's validation code.

How to use it?

To use the exercises plugin in your Gitbook project, add the exercises plugin to the book.json file, then install plugins using gitbook install.

{
    "plugins": ["exercises"]
}

Exercises format

An exercise is defined by 4 simple parts:

  • Exercise Message/Goals (in markdown/text)
  • Initial code to show to the user, providing a starting point
  • Solution code, being a correct solution to the exercise
  • Validation code that tests the correctness of the user's input
  • Context (optional) code evaluated before executing the user's solution
{% exercise %}
Define a variable `x` equal to 10.

{% initial %}
var x =

{% solution %}
var x = 10;

{% validation %}
assert(x == 10);

{% context %}
// This is context code available everywhere
// The user will be able to evaluate `exposedVar`
var exposedVar = 3;
// ... or call `exposedFunction`
function exposedFunction {
    return 3;
}
{% endexercise %}

The old format (gitbook < 2.0.0) is no longer supported.

Plugin

Interactive exercices in a gitbook

https://github.com/GitbookIO/plugin-exercises


Latest: 3.0.0

0.0.0, 1.0.0, 2.0.0-alpha.2, 2.0.0-alpha.3, 2.1.0, 2.1.1, 3.0.0,

Requirements

GitBook
1.0.0 >=1.0.0
2.0.0-alpha.3 >1.x.x
3.0.0 >=3.0.0-pre.0

Maintainers

Open on NPM