NeatPages0.3.5

The un-opinionated Grunt boilerplate you've been looking for.

Whether you're a Sass freak a LESS lover or just rock straight CSS, NeatPages has you covered. Pick the right tools for your next project and then get grunting.

								
[?] Project title (New Site) 
[?] Description (The best website ever made!) 
[?] Theme alias (alpha and underscore characters only) 
[?] Version number (0.0.1)
[?] Create a README file for your project? (y/N) 
[?] CSS Preprocessor: Will you use "Sass", "LESS", or "none" for CSS with this project? 
[?] Path relative to index.html that assets will be stored. Use "./" for root. 
[?] Bourbon: Would you like a glass of bourbon with this project? (y/N) 
[?] Bourbon: Would you like that bourbon neat? (y/N) 
[?] Icon Set: Will you use "Font Awesome", ionicons, or "none" with this project? 
[?] Boilerplate: Will you use "HTML5 Boilerplate", "Bootstrap", "Foundation 5" or "none" with this project? 
[?] Project homepage (none) 
[?] Author name (Your Name) 
[?] Author email (you@me.com) 
[?] Author url (none) 
[?] Project git repository (git://github.com/yourname/newsite.git) 
[?] Project issues tracker (https://github.com/yourname/newsite/issues)
								
							

Get Started

  
git clone git@github.com:jpdevries/neat-pages.git ~/.grunt-init/neat-pages
git clone git@github.com:jpdevries/neat-pages.git %USERPROFILE%/.grunt-init/neat-pages

Choose your Tools

Choose a CSS Preprocessor

Tip: If you choose Sass you can have a glass of Bourbon, Neat.

Choose an Icon Set

Choose Font Awesome, ionicons, or none.

Choose a Front End Framework

Sleep on it if you need to. We'll be here.

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

grunt-init neat-pages

Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.

Installing Dependencies

You'll now be asked a series of questions on how you'd like to configure your project. NeatPages will then quickly build the project of your dreams. You're now ready to Grunt! Never Grunted before? Have no fear, more info is here.

NeatPages makes getting started with Grunt easy. Enter the _build directory and run npm install to install your projects node dependencies. Then, you're ready to build your project!

cd _build
npm install
grunt build

NeatPages comes with a Grunt task that will watch your files for changes and trigger LiveReload in your browser to make viewing changes a breeze. All you gotta do is grunt like so:

grunt

Grunt is now watching for changes. To terminate this process press Ctrl+C in your Terminal window.

Grunt Tasks

Build

Run this first to fetch dependencies as well as pre-process and concanetate JavaScript and CSS.

grunt build

Watch

Pre-process CSS & JavaScript, then watch files for changes.

grunt

Request a Feature

The web is always changing and so are the best tools to build for it. We try to stay on top of all the madness but if you think NeatPages is missing something super special let us know.


Note: NeatPages is currently being ported from grunt-init to being a Yeoman generator.