https://github.com/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.
https://github.com/assemble/generator-assemble

Last synced: about 1 year ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/assemble/generator-assemble
• Owner: assemble
• Created: 2013-04-22T02:56:41.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2014-10-29T00:48:17.000Z (over 11 years ago)
• Last Synced: 2025-03-21T01:48:30.203Z (about 1 year ago)
• Language: JavaScript
• Homepage: http://assemble.io/docs/Resources.html
• Size: 1.73 MB
• Stars: 112
• Watchers: 12
• Forks: 23
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Assemble generator [![Build Status](https://travis-ci.org/assemble/generator-assemble.svg)](https://travis-ci.org/assemble/generator-assemble)

> [Yeoman][yeoman] generator for [Assemble][assemble].

## Getting started

Install the generator from [npm](npmjs.org):

``` bash

npm i -g generator-assemble

```

## Usage

Generate a new Assemble project:

```bash

yo assemble

```

_Do not initialize your project in a sub folder next to `.yo-rc.json` because your files will land here and not in your subfolder from where you are initializing project._

#### Generator options

* `-i` alias `--init`

  Force to prompt question and re-initialize `.yo-rc.json`.

* `-s` alias `--skip-install`

  Skips the automatic execution of `bower` and `npm` after scaffolding has finished.

* `-w` alias `--skip-welcome-message`

  Skips app welcome message.

## Included Grunt tasks

* grunt-contrib-clean

* grunt-contrib-connect

* grunt-contrib-watch

* time-grunt

## Boilerplate

The following directory structure is generated after running `yo assemble`:

    .

    ├── .editorconfig

    ├── .gitignore

    ├── .yo-rc.json

    ├── AUTHORS

    ├── CHANGELOG

    ├── Gruntfile.js

    ├── LICENSE-MIT

    ├── package.json

    ├── README.md

    ├── dist

    │   └── assets

    │       ├── css

    │       │   ├── bootstrap.css

    │       │   ├── bootstrap.min.css

    │       │   └── theme.css

    │       ├── js

    │       │   └── bootstrap.min.js

    │       └── fonts

    │           ├── glyphicons-halflings-regular.eot

    │           ├── glyphicons-halflings-regular.svg

    │           ├── glyphicons-halflings-regular.ttf

    │           └── glyphicons-halflings-regular.woff

    ├── src

    │   ├── content

    │   │   └── markdown.md

    │   ├── data

    │   │   └── site.yml

    │   └── templates

    │       ├── layouts

    │       │   └── default.md

    │       ├── pages

    │       │   ├── index.hbs

    │       │   └── blog.hbs

    │       └── partials

    │           └── navbar-fixed-top.hbs

    └── node_modules

## Related

 * [Assemble Helper generator](https://github.com/assemble/generator-helper)

 * [Assemble Plugin generator](https://github.com/assemble/generator-plugin)

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)

[yeoman]: http://yeoman.io/

[assemble]: http://assemble.io