/jade-stylus-grunt.docpad

A Jade, Stylus, Grunt Boilerplate for Docpad

Primary LanguageCoffeeScriptOtherNOASSERTION

A Jade, Stylus, Grunt Boilerplate for Docpad

Based on this and this.

Stylus includes Nib, Normalize v2.1.0, and a slightly altered Semantic.gs. A Bower component.json and .bowerrc file are also included.

Getting Started

  1. Install DocPad

  2. Clone the project and run the server

    git clone git://github.com/kylamedina/jade-stylus-grunt.docpad.git
cd jade-stylus-grunt.docpad
npm install
docpad run

  3. Open http://localhost:9778/

  4. Start hacking away by modifying the src directory

Grunt

Grunt will minify and concatenate all files in src/documents/js and create out/js/vendor.min.js

It can also minify CSS but I use Stylus so that's not really necessary.

grunt-config.json

  • This file is contains the object passed to grunt.initConfig in grunt.js. It has been put into its own file since it is used in docpad.coffee to build file lists for inclusion in the layout and deleting unused files.

grunt.js

  • This is the Grunt file. It runs initConfig with the grunt-config.json object. It also registers a default task with all the keys from the config file.

docpad.coffee

  • These helper functions have been added: getGruntedStyles and getGruntedScripts. They will return all the compiled assets that contain .min.(css|js) with the correct base path.
  • A writeAfter DocPad event. It is based on this gist, with some additional functionality. It will run the default grunt command. Then it will use your grunt-config.json to delete the src files since they are no longer needed. It will also delete any empty directories in the 'out/' directory.

layouts/default.html.eco

  • The script and style blocks have been replaced with calls to the helper functions described above.

Bower

Bower is a package manager for the web. Read about it here.

License

This skeleton is made "public domain" using the Creative Commons Zero, as such before you publish your website you should place your desired license here and within the LICENSE.md file.

If you are wanting to open-source your website, we suggest using the Creative Commons Attribution License for content and the MIT License for code. In which case you'd probably want to use the following as your license:

Unless stated otherwise, all content is licensed under the [Creative Commons Attribution License](http://creativecommons.org/licenses/by/3.0/) and code licensed under the [MIT License](http://creativecommons.org/licenses/MIT/), © [Your Name](http://your.website)

If you are wanting to close-source your website, we'd suggest using the following:

Copyright [Your Name](http://your.website). All rights reserved.

Other included things such as themes and libraries are likely already licensed by their own invidual licenses, so be sure to respect their licenses too.