Static site generator for Grunt.js and Yeoman. Assemble makes it dead simple to build modular sites, blogs, gh-pages, components and documentation from reusable templates and data.
Static site generator for Grunt.js and Yeoman. Assemble makes it dead simple to build modular sites, blogs, gh-pages, components and documentation from reusable templates and data.
layouts to wrap your pages with commonly used elements and content....and of course, we use Assemble to build the project's own documentation http://assemble.io:
Assemble requires Grunt ~0.4.1
If you haven't used grunt before, be sure to check out the Getting Started guide.
From the same directory as your project's Gruntfile and package.json, install Assemble with the following command:
npm install assemble --save-dev
Once that's done, add this line to your project's Gruntfile:
grunt.loadNpmTasks('assemble');
Run the "assemble" task with the grunt assemble command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
In your project's Gruntfile, add a section named assemble to the data object passed into grunt.initConfig().
assemble: {
options: {
assets: 'assets',
plugins: ['permalinks'],
partials: ['includes/**/*.hbs'],
layout: ['layouts/default.hbs'],
data: ['data/*.{json,yml}']
},
pages: {
src: ['docs/*.hbs'],
dest: './'
}
},
See the documentation for Options for more information.
Type: String
Default: undefined
Used with the {{assets}} variable to resolve the relative path from the dest file to the assets folder.
Type: String|Array|Object
Default: src/data
Specify the data to supply to your templates. Data may be formatted in JSON, YAML, YAML front matter, or passed directly as an object. Wildcard patterns may also be used.
Type: String
Default: undefined
The directory to use as the "cwd" for layouts. When this option is defined, layouts may be defined using only the name of the layout.
Type: String
Default: undefined
If set, this defines the layout file to use for the task or target. However, when specifying a layout, unlike Jekyll, Assemble requires a file extension since you are not limited to using a single file type.
Type: String
Default: undefined
Specify the extension to use for layouts, enabling layouts in YAML front matter to be defined without an extension:
---
layout: default
---
Type: String|Array
Default: undefined
Specifies the Handlebars partials files, or paths to the directories of files to be used.
Type: String|Array
Default: undefined
Name of the npm module to use and/or the path(s) to any custom plugins to use. Wildcard patterns may also be used.
See the docs for plugins.
Type: String|Array
Default: handlebars-helpers
Name of the npm module to use and/or the path(s) to any custom helpers to use with the current template engine. Wildcard patterns may also be used.
By default, Assemble includes handlebars-helpers as a dependency, so any helpers from that library are already available to be used in your templates.
See the docs for helpers.
Type: Function
Default: undefined
Function to use for post-processing generated HTML.
"Prettify" HTML
npm install pretty, then add the following config to apply formatting to any generated HTML:
options: {
postprocess: require('pretty')
}
String transformations
npm install frep and add the following config to find and replace content:
options: {
postprocess: function(src) {
return require('frep').replaceStr(src, [
{
// Remove leading whitespace
pattern: /^\s*/,
replacement: ""
},
{
// replace "Jekyll" with "Assemble" (jk ;-)
pattern: "Jekyll",
replacement: "Assemble"
}
]);
}
}
Type: String
Default: .html
Specify the file extension for destination files. Example:
Type: Object
Default: Marked.js defaults
Specify the Marked.js options for the {{#markdown}}{{/markdown}} and {{md ""}} helpers to use when converting content.
Type: String
Default: Handlebars
Specify the engine to use for compiling templates if you are not using Handlebars.
PLEASE NOTE that this option is only necessary if:
a. You are not using Handlebars, or b. You need to "force" Handlebars to recognize a non-default extension. See extensions.yml.
Also see assemble-swig for compiling Swig Templates.
Type: Boolean
Default: false
Remove anything after (and including) the first . in the destination path, then append this value. In other words, when files are generated from different source folders this "flattens" them into the same destination directory. See [building the files object dynamically][files-object] for more information on files formats.
Visit Assemble's documentation for more information about options.
Simple example of using data files in both .json and .yml format to build Handlebars templates.
assemble: {
options: {
data: 'src/data/**/*.{json,yml}'
},
docs: {
files: {
'dist/': ['src/templates/**/*.hbs']
}
}
}
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/'
}
},
Visit Assemble's documentation for many more examples and pointers on getting started.
Find a bug? Have a feature request? Please create an Issue.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt, and build the documentation with grunt-readme.
Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!
Here are some related projects you might be interested in from the Assemble core team.
Visit assemble.io/plugins for more information about Assemble plugins.
Jon Schlinkert
Brian Woodward
helper.register allowing grunt and assemble to be passed in and used from inside helpers.options.data can now also directly accept an object of data.originalAssets property to root context to store the pre-calculated assets pathplugins option. thanks @adjohnson916!layoutext and postprocess options.Copyright (c) 2013 Assemble, contributors. Released under the MIT license
This file was generated by grunt-readme on Thursday, December 5, 2013.
FAQs
Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit
The npm package assemble receives a total of 3,877 weekly downloads. As such, assemble popularity was classified as popular.
We found that assemble demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.