generator-stratic

generator-stratic

The streaming static site generator

Yeoman generator

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-stratic from npm, run:

npm install -g generator-stratic

Finally, initiate the generator:

yo stratic

Testing

generator-stratic tests can be run with npm test. If you want to run all tests, including very expensive ones that take a lot of time, export STRATIC_TEST_EXPENSIVE to the environment with a value of true, like so:

$ export STRATIC_TEST_EXPENSIVE=true
$ npm test

Travis CI will run all expensive tests by default, so most of the time you can just run the inexpensive tests locally and let Travis run the expensive ones when you submit a Pull Request.

License

Yeoman is licensed under the MIT license. generator-stratic is licensed under the LGPL 3.0 or later.

Naming

Stratic stands for STReaming stATIC site generator.

I also considered Glug, which stands for GulpLog Universal Generator. GulpLog is supposed to sound similar to weblog and Glug is supposed to sound similar to Gulp. In the end, though, Stratic won out.