The build script have a set of very helpful commands, run npm install --dev (only required once) and then check the available commands by running node build --help

  Usage: build [options] [command]

  Commands:

    doc
    build documentation.

    pkg
    update packages and specs

    add <moduleName> [templateName]
    add a new module.

    mv <moduleName> <newName>
    rename module.

    cjs <destinationPath>
    convert mout into a node.js compatible package.

    release <version>
    bump version number, update packages and run tests

    testling
    prepare files for ci.testling.com

  Options:

    -h, --help    output usage information
    -s, --silent  suppress log messages.

The build script can be used to update packages and specs files:

node build pkg

The packages/specs are automatically updated every time you run npm test as well.

You can also add new modules with the command:

node build add package/moduleName

This will create a new module src/package/moduleName.js and also a failing spec tests/spec/package/spec-moduleName.js. - "Automate all the things!"

The documentation is generated based on markdown files inside the doc folder using mdoc. To compile the docs run:

node build doc

It will replace all the files inside the doc_html folder.

Documentation files should be always up-to-date since modules are only committed to the master branch after they get proper tests and documentation.

We do not push the HTML docs to the repository to avoid duplicated info (user can browse the markdown files on github) and also because http://moutjs.com/ should contain docs for each release.