0.1.0 • Published 8 years ago

molecule-js v0.1.0

Weekly downloads
9
License
MIT
Repository
github
Last release
8 years ago

Molecule

Build Status NPM Release

RSS / Atom Feed Blog Aggregator

Dependencies

  • NodeJS
  • NPM

Installation

Global

npm install -g molecule-js

Local

You can also install Molecule per-project, just run

npm install molecule-js

and use ./node_modules/.bin/molecule as the command.

Programmatic

To use Molecule programmatically, see ./src/cli.js as an example.

var molecule = new Molecule(pathToConfigDir, options);
//...
molecule.build();

Usage

$ molecule --help

molecule [options] <config directory>

Options:
  --pretty, -p
    Disables minification
  --output, -o <build directory>
    Default: <config directory>/build/

Config Directory

See ./config/ as an example.

PathDescription
./config.jsonConfiguration of your aggregator
./templates/Templates you want to generate

Templates

Currently only Pug (previous known as Jade) templates are supported. Support for other engines might be added if they're needed.

Currently directories in the templates directory aren't supported.

To know which variables are available, see the example templates under ./config/templates. Actual documentation may be added in the future.

Templates have a naming scheme:

./templates/./build/
atom.xml.pugatom.xml
README.pugREADME

License

See LICENSE