boilerplates
Version:
Boilerplates for Assemble.
119 lines (66 loc) • 4.29 kB
Markdown
# assemble-bootstrap [](http://badge.fury.io/js/assemble-bootstrap)
> Build Bootstrap using Assemble instead of Jekyll. Assemble is a site-generator built as a Grunt.js plugin, so it runs entirely on Node.js.
## Getting Started
This plugin requires Grunt `~0.4.1`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install assemble-bootstrap --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('assemble-bootstrap');
```
## Boilerplate task
_Run this task with the `grunt boilerplate` command._
### assemble-examples
> A collection of example projects for working with [Assemble](https://github.com/assemble/)
#### Getting Started
This repo provides an overview of some example projects for using Assemble. To get started:
* Visit one of the example projects
* **[Download this project][download]** and unzip it into a new folder.
* In the project folder, run `npm install` to install [Assemble][assemble], [Grunt](http://gruntjs.com/) 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](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile][gruntfile], as well as install and use Grunt plugins.
#### Examples
Most of the example projects are pretty basic, and we try to incorporate examples for both templates and data in each project but you can get away with fewer files and less abstraction.
###### [cheatsheet](http://github.com/upstage/cheatsheet)
> Build a beautiful, dynamic cheatsheet component, consisting of nested accordions and syntax highlighting for code examples.
This cheatsheet component was constructed for the new, upcoming [Lesscss.org](http://lesscss.org) website.
* Layouts
* Pages
* Partials
* YAML Front-matter
* Markdown content
###### [assemble-examples-basic](http://github.com/assemble/assemble-examples-basic) [](https://travis-ci.org/assemble/assemble-examples-basic)
> Assemble a basic site using:
* Layouts
* Pages
* Partials
* YAML Front-matter
* Markdown content
###### [assemble-examples-readme](http://github.com/assemble/assemble-examples-readme) [](https://travis-ci.org/assemble/assemble-examples-readme)
> Assemble a GitHub README.md, with very basic:
* `README.hbs` template
* Handlebars Helpers for changelog, authors and roadmap
* YAML data
* Markdown content
###### [assemble-examples-sitemap](http://github.com/assemble/assemble-examples-sitemap) [](https://travis-ci.org/assemble/assemble-examples-sitemap)
> Use Assemble to generate a Sitemap.xml from:
* `sitemap.hbs` template
* Example data
#### Release History
* 2013-04-24 v0.1.2 add assemble-examples-sitemap
* 2013-04-19 v0.1.1 add assemble-examples-readme
* 2013-04-19 v0.1.0 initial release
[assemble]: https://github.com/assemble/assemble/
[wiki]: https://github.com/assemble/assemble/wiki
[download]: https://github.com/assemble/assemble-examples-basic/archive/master.zip
[gruntfile]: http://gruntjs.com/sample-gruntfile
[configuring tasks]: http://gruntjs.com/configuring-tasks
[tasks-and-targets]: http://gruntjs.com/configuring-tasks#task-configuration-and-targets
[files-object]: http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
## Release History
* 2013-07-30 v0.1.0 Fork from grunt-contrib-internal
***
Project authored by [Jon Schlinkert](https://github.com/jonschlinkert/).
_This file was generated on Sat Aug 10 2013 13:50:20._