Skip to content

muledesign/chug

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Chug

Chug is a simple Grunt-based development tool that will build a nice static HTML site for you, based on your many templates and assets. Chug is a little bit opinionated, and assumes that you are an intelligent and attractive person who loves Mustache and Sass.

Getting Started

Put Chug's gruntfile in a directory and run grunt new to get your directory structure. Run grunt watch and start writing code. That's it!

Your Sass will compile to CSS, and Mustache templates in templates/pages will compile to flat HTML in the project root directory.

Components:

Todos:

  • Automatic image compression.
  • Commission a logo featuring an image of Rupert.
  • When libsass 3.4 comes out, make the switch.
  • Some kind of script that makes it easy to install chug in a directory. Something like chug install and the gruntfile magically appears and runs npm install. Might also be cool to have chug act as an alias for Chug's grunt tasks, so you can run chug watch.
  • Coffeescript support for people who want it.

Troubleshooting

Updating for (newer) Node

Chug is built around Node 4+. If you're running 6+ you'll need to update some packages to get this running on you machine. Follow these steps to update Sass:

  • Clone the repo
  • Move into your new directory
  • npm install
  • npm rebuild node-sass

About

A very simple Grunt-based static web development tool

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published