Armadillo

What is Armadillo

Armadillo is a Yeoman Generator designed for building static sites. It utilizes Handlebars for HTML and Sass+Compass for CSS. It also makes it easy to pull in Require.js and publish your site to GitHub Pages.

Getting Started

Armadillo gets run from the command line, so you're going to need to be comfortable working in it. All of the following commands will need to be run from your command line. If you get permission issues, you will need to run the commands using sudo.

Using Armadillo

To develop your site, run grunt server to run a development server. Include --launch to launch the site after the server has started. To package your site, run grunt build. This will package your site for production. Include --commit or --commit="message" to automatically commit the packaged site into your Git version control To deploy your site to GitHub Pages, run grunt deploy after you've built your site. If you would like to export your packaged site, run grunt export. This will export your packaged site to an export folder. If you would like to choose where to export the package to, include --to="~/path/to/destination".

Helper Functions

Armadillo comes with helper functions for use in your HTML and Markdown pages to ease development.

Basic Configuration

There is a config.json file that will allow you to control many of the aspects of Armadillo.

Advanced Configuration

There is a .system.json file that has advanced system-level settings that, if you change, will change many things throughout the project, so change with care.

Configuring JSHint and CSS Lint

Armadillo will help you make your code better by running your JavaScript through JSHint and your CSS through CSS Lint. You can configure JSHint by editing .jshintrc and CSS Lint by editing .csslintrc.