assemble

Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt, Less.js / lesscss.org, Topcoat, Web Experience Toolkit, and hundreds of other projects to build sites, themes, components, documentation, blogs and gh-pages.

Visit the website →

Why use Assemble?

1. Most popular site generator for Grunt.js and Yeoman. Assemble is used to build hundreds of web projects, ranging in size from a single page to 14,000 pages (that we're aware of!). Let us know if you use Assemble.
2. Allows you to carve your HTML up into reusable fragments: partials, includes, sections, snippets... Whatever you prefer to call them, Assemble does that.
3. Optionally use layouts to wrap your pages with commonly used elements and content.
4. "Pages" can either be defined as HTML/templates, JSON or YAML, or directly inside the Gruntfile.
5. It's awesome. Lol just kidding. But seriously, Assemble... is... awesome! and it's fun to use.

The "assemble" task

Getting Started

npm install assemble --save-dev

grunt.loadNpmTasks('assemble');

The "assemble" task

assemble:{
options:{
assets:'assets',
plugins:['permalinks'],
partials:['includes/**/*.hbs'],
layout:['layouts/default.hbs'],
data:['data/*.{json,yml}']
},
site:{
src:['docs/*.hbs'],
dest:'./'
}
},

Options

assets

data

layoutdir

layout

layoutext

---
layout:default
---

partials

plugins

helpers

ext

marked

engine

flatten

Usage Examples

assemble:{
options:{
data:'src/data/**/*.{json,yml}'
},
docs:{
files:{
'dist/':['src/templates/**/*.hbs']
}
}
}

Using multiple targets

assemble:{
options:{
assets:'assets',
layoutdir:'docs/layouts'
partials:['docs/includes/**/*.hbs'],
data:['docs/data/**/*.{json,yml}']
},
site:{
options:{
layout:'default.hbs'
},
src:['templates/site/*.hbs'],
dest:'./'
},
blog:{
options:{
layout:'blog-layout.hbs'
},
src:['templates/blog/*.hbs'],
dest:'articles/'
},
docs:{
options:{
layout:'docs-layout.hbs'
},
src:['templates/docs/*.hbs'],
dest:'docs/'
}
},

Contributing

Assemble plugins

• assemble-middleware-anchors: Assemble middleware for creating anchor tags from generated html.
• assemble-middleware-contextual: Assemble middleware for generating a JSON file containing the context of each page. Basic middleware to help see what's happening in the build.
• assemble-middleware-decompress: Assemble plugin for extracting zip, tar and tar.gz archives.
  
• assemble-middleware-download: Assemble middleware for downloading files from GitHub.
• assemble-middleware-drafts: Assemble middleware (v0.5.0) for preventing drafts from being rendered.
• assemble-middleware-i18n: Assemble middleware for adding i18n support to projects.
• assemble-middleware-lunr: Assemble middleware for creating a search engine within your static site using lunr.js.
• assemble-middleware-permalinks: Permalinks middleware for Assemble, the static site generator for Grunt.js and Yeoman. This plugin enables powerful and configurable URI replacement patterns, presets, uses Moment.js for parsing dates, and much more.
• assemble-middleware-rss: Assemble middleware for creating RSS feeds with Assemble. (NOT published yet!)
• assemble-middleware-sitemap: Assemble middleware for generating sitemaps.
• assemble-middleware-toc: Assemble middleware for creating a table of contents in the generated HTML, using Cheerio.js
• assemble-middleware-wordcount: Assemble middleware for displaying a word-count, and estimated reading time on blog posts or pages.
  

Authors

• github/jonschlinkert
• twitter/jonschlinkert

• github/doowb
• twitter/doowb