generator-propeller

Yeoman generator for Propeller, a static site generator built on Assemble and Bootstrap 3

npm install generator-propeller
22 downloads in the last week
24 downloads in the last month

generator-propeller 0.5.6

Yeoman generator for Propeller, a static site generator built on Assemble and Bootstrap 3.

Getting started

  1. Download and install Node
  2. At the command line install Yeoman, Bower and Grunt globally by typing sudo npm install -g yo bower grunt-cli
  3. Install the Propeller generator for Yeoman by typing sudo npm install -g generator-assemble

Usage

  1. Create an empty folder for your Propeller project, and navigate into it at the command line
  2. Generate a new Propeller project in the folder by typing yo propeller at the command line and following the prompts

Now you're ready to use Propeller

  1. Once Yeoman is finished creating your project, type grunt at the command line to run the tasks to generate your static site, which will appear in a /dist folder
  2. Type grunt serve to start your development server. Propeller will monitor the files in the /src folder and update your static site whenever it detects changes
  3. Open http://localhost:9000 in a web browser to view your site
  4. Begin creating your site by modifying the files in the /src folder

Additional Information

  • Propeller uses Assemble and Handlebars as its templating engine
  • When the server is running it monitors for file updates, and automatically regenerates the static files
  • The server also monitors for changes to LESS files, and automatically compiles them into static CSS files when updated

Resources

License

The MIT License (MIT)

Copyright (c) 2014 Dane Petersen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you