Demonstrates how to use Assemble to build a site. Includes layouts, pages, partials, and markdown content.
JavaScript
Switch branches/tags
Nothing to show
Latest commit 46f3174 May 6, 2014 @nschonni nschonni Merge pull request #10 from makotot/travis
replace the badge to travis

README.md

boilerplate-site Build Status

Boilerplate for generating a basic static site with Assemble.

NOTICE: THIS BOILERPLATE IS BEING REFACTORED

You may find outdated information or examples in this project. While we're refactoring, you might be more interested in boilerplate-bootstrap in the meantime.

Getting Started

  • Download this project and unzip it into a new folder.
  • In the project folder, run npm install to install Assemble, Grunt and any other dependencies.
  • Once the dependencies are installed you may run grunt assemble to build the example project.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile, as well as install and use Grunt plugins.

The "assemble" task

Overview

In the project's Gruntfile, the example assemble task is pre-loaded with paths and options following standard Grunt.js conventions:

grunt.initConfig({
  // The "assemble" task
  assemble: {
    // Task-level options.
    options: {
      flatten: true,
      assets: 'dist/assets',
      layout: 'templates/layouts/default.hbs',
      partials: 'templates/partials/*.hbs',
      data: 'src/data/*.{json,yml}'
    },
    // Templates to build into pages
    pages: {
      files: {
        'dist/': ['templates/pages/*.hbs']
      }
    }
  }
})

Boilerplate Author

Jon Schlinkert

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Use Assemble to build and maintain your gh-pages, blog or documentation. Lint and test your code using Grunt.