Welcome!

Thanks for visiting the Assemble docs! Find something that needs to be fixed or updated? Please let us know.

Updates

• Effeckt uses Assemble! - a h5bp project focused on "UI-less, performant transitions & animations". If you haven't seen it, definitely check it out, it's pretty awesome.
• assemble-bootstrap is a new boilerplate to build Twitter Bootstrap 3.0.0 with Assemble and Grunt.js. No need for Ruby, Jekyll, or running a server to view the docs. This repo is up-to-date and includes qunit and phantomjs tests.

Common Questions

Does Assemble have a CLI?

Not yet, but we're planning to introduce a number of new features in the next major version of Assemble. You are invited to be a part of the planning process.

Does Assemble require Grunt? Can it be used without Grunt?

For the time being, yes, and no.

What is the fastest way to learn how to use Assemble?

That depends on how you learn, but here are some really great starting points:

1. assemble/buttons. We think this is the best place to start, since this project was created to be instructive. It demonstrates how Assemble works through a series of examples, where each example builds upon the last and, in general, adds something new that didn't exist in the previous example. The examples also begin very basic and increase in complexity over time.
2. assemble/grunt-init-assemble. Grunt init template for Assemble, the static site generator built on Grunt.js. Kickstart new Assemble projects in just a few seconds, including templates, data, layouts, and a theme.
3. assemble/generator-assemble. Yeoman generator for Assemble, the static site generator built on Grunt.js. Kickstart new Assemble projects in just a few seconds, including templates, data, layouts, and a theme.

Getting Started

• About
• FAQ
• Installation
• Quickstart
• Resources

Configuration

• Built-In Variables
• Options Overview
  • options.assets
  • options.collections
  • options.data
  • options.engine
  • options.ext
  • options.helpers
  • options.layout
  • options.layoutdir
  • options.marked
  • options.partials

Data

• Context
• Data
  • YAML Front Matter
  • YAML data

Templates

• Templates Overview
• Custom helpers
• Helpers
• Layouts
• Pages
• Pages Collections
• Partials

Content

• Markdown

Boilerplates

• Resources
• All boilerplates
• Creating a Basic Site
• Generate a README, wiki or markdown documentation
• Create sitemap

Development

• Methods

Other

• External Libraries

Related Projects

• assemble-less

Community Projects

Does your project use Assemble? Did you write a blog post about Assemble? Make a video, or create a "community" project based on Assemble? Please let us know!   We'll post a link to it on our docs. Thanks for thinking of us!

---

See the template for this page →