assemble/generator-assemble assemble/generator-assemble

  • Stars
    star
    114
  • Rank 308,031 (Top 7 %)
  • Language
    JavaScript
  • Created over 11 years ago
  • Updated about 10 years ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
assemble/generator-assemble
github

assemble

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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.

Assemble generator Build Status

Yeoman generator for Assemble.

Getting started

Install the generator from npm:

npm i -g generator-assemble

Usage

Generate a new Assemble project:

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

License

MIT License

More Repositories

1

assemble

Get the rocks out of your socks! Assemble makes you fast at web development! Used by thousands of projects for rapid prototyping, themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websites/static site generator, an alternative to Jekyll for gh-pages and more! Gulp- and grunt-friendly.
CSS
4,244
star
2

assemble.io

Website and documentation for Assemble.
CSS
82
star
3

assemble-boilerplate-bootstrap

Build Bootstrap with Assemble instead of Jekyll.
CSS
75
star
4

boilerplates

Boilerplates for Assemble. Each boilerplate offers something different: static site generation, h5bp, Bootstrap, swig, markdown, blog generation, etc.
JavaScript
68
star
5

gulp-assemble

Deprecated. Assemble can be used directly with or without gulp.
JavaScript
67
star
6

assemble-less

Grunt task for compiling LESS to CSS. This task does for less what Assemble does for HTML, making it much easier to modularize and reduce repetition in stylesheets.
JavaScript
66
star
7

grunt-assemble

Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP, Topcoat, Web Experience Toolkit, and hundreds of other projects to build sites, themes, components, documentation, blogs and gh-pages.
HTML
55
star
8

assemble-boilerplate-site

Demonstrates how to use Assemble to build a site. Includes layouts, pages, partials, and markdown content.
JavaScript
46
star
9

grunt-assemble-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.
HTML
43
star
10

buttons

Sooo many buttons... is this really necessary?! In reality this project has little to do with buttons. It's an exercise in separation of concerns regarding structure, style, content and data.
HTML
39
star
11

assemble-pattern-lab

An easier-to-use, cleaner and more extensible build system for pattern-lab.
JavaScript
26
star
12

grunt-assemble-i18n

Assemble middleware for adding i18n support to projects.
JavaScript
24
star
13

assemble-workshop

Recipes how to use assemble (v0.12.0+)
JavaScript
22
star
14

grunt-assemble-sitemap

Assemble middleware for generating sitemaps.
JavaScript
20
star
15

grunt-github-api

Grunt plugin used to query the Github API and save the returned JSON files locally.
JavaScript
17
star
16

assemble-core

The core assemble application with no presets or defaults. All configuration is left to the implementor.
JavaScript
17
star
17

assemble-boilerplate-markdown

Use Assemble to generate HTML pages from markdown content. Useful for wikis, gh-pages, documentation and blogs or sites with markdown posts.
JavaScript
17
star
18

grunt-assemble-lunr

grunt-assemble plugin for creating a search engine within your static site using lunr.js.
JavaScript
12
star
19

grunt-assemble-navigation

Assemble plugin for automatically generating Bootstrap-style side navigation.
JavaScript
10
star
20

assemble-swig

Assemble engine plugin for swig templates.
JavaScript
10
star
21

assemble-boilerplate-blog

Assemble boilerplate with the essential middleware, helpers, templates and (opinionated) configuration necessary to easily create a blog with Assemble.
CSS
10
star
22

grunt-assemble-wordcount

Assemble middleware for displaying a word-count, and estimated reading time on blog posts or pages.
JavaScript
10
star
23

assemble-tags-collection-example

Example of how to generate an index page with a list of tags extracted from front matter. Each "tag" has a list of links to any pages that have that tag.
JavaScript
9
star
24

assemble-handlebars

Assemble engine plugin for Handlebars templates
JavaScript
8
star
25

assemble-middleware-rss

Assemble middleware for creating RSS feeds with Assemble.
JavaScript
7
star
26

assemble-boilerplate-sitemap

Generate a sitemap with Assemble.
JavaScript
7
star
27

assemble-indexer

Templates plugin to add index views to template collections.
JavaScript
7
star
28

grunt-assemble-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.
JavaScript
7
star
29

assemble-yaml

Utility for extracting and converting YAML Front Matter from files.
JavaScript
6
star
30

assemble-fs

Assemble plugin that adds methods to assemble for working with the file system, like src, dest, copy and symlink.
JavaScript
6
star
31

assemble-front-matter

Utilities for extracting Front Matter from source files.
JavaScript
6
star
32

assemble-helpers

Plugin that adds helpers for assemble projects. Includes both sync and async helpers that take advantage of assemble's powerful features.
JavaScript
6
star
33

assemble-collections

Node library to manage collections of objects in or out of Assemble.
JavaScript
5
star
34

grunt-assemble-toc

Assemble middleware for creating a table of contents in the generated HTML, using Cheerio.js
JavaScript
5
star
35

assemblebot

Bot for responding to github issues opened on assemble repositories.
JavaScript
5
star
36

assemble-permalinks

Permalinks plugin for assemble (0.6+)
JavaScript
5
star
37

generator-plugin

Yeoman generator for Assemble plugins.
JavaScript
5
star
38

assemble-layouts

Layouts for your templates
JavaScript
5
star
39

assemble-example

This project will help you get started with Assemble. Just download, install the dependencies, and you're off and running!
JavaScript
5
star
40

assemble-sitemap

Assemble pipeline plugin for generating sitemaps for one or more collections.
JavaScript
5
star
41

grunt-assemble-anchors

Assemble plugin for creating anchor tags from generated html.
HTML
5
star
42

assemble-utils

Assemble utilities
JavaScript
4
star
43

grunt-assemble-download

Assemble middleware for downloading files from GitHub.
HTML
4
star
44

assemble-render-file

Assemble pipeline plugin for rendering templates in vinyl files.
JavaScript
4
star
45

assemble-select-files

Assemble plugin that adds a `.selectFiles` method to the instance, for reading in a glob of files and prompting the user to select the files they want to write to the file system.
JavaScript
4
star
46

assemble-pager

Assemble plugin that adds prev/next pager information to the context, for a specific collection, specific files or all files in a stream.
JavaScript
4
star
47

assemble-nunjucks

Adds nunjucks support to assemble, with some assemble-specific conveniences.
JavaScript
3
star
48

grunt-assemble-decompress

Assemble plugin for extracting zip, tar and tar.gz archives.
JavaScript
3
star
49

assemble-ask

Assemble plugin for asking questions and storing answers.
JavaScript
3
star
50

assemble-components

POC
3
star
51

assemble-handlebars-helpers

A handful of helpers that replace the built-in Handlebars helpers, with changes made for handling assemble specifics like context and errors.
JavaScript
3
star
52

assemble-loader

Assemble plugin for loading views onto collections from globs of files, as objects/JSON etc.
JavaScript
3
star
53

assemble-middleware-page-variable

Assemble middleware for adding a `page` variable to the context, with details about the current item being rendered.
JavaScript
3
star
54

assemble-handle

Assemble pipeline plugin for handling middleware stages.
JavaScript
3
star
55

slack

Slack landing page to provide an invitation form for the assemble slack community.
JavaScript
3
star
56

assemble-streams

Assemble plugin that adds convenience methods for working with streams, like `toStream`, which pushes a view collection into a vinyl stream.
JavaScript
3
star
57

context-workshop

One of assemble's biggest strengths is granular control over `context`. This workshop explains how context is created, as well as where, when and why the context works the way it does at each point in the render cycle.
JavaScript
3
star
58

assemble-cli

Command line interface for Assemble.
JavaScript
2
star
59

assemble-middleware-add

Add files to your Assemble file stream.
JavaScript
2
star
60

assemble-select-views

Assemble plugin that adds a `.selectViews` method to the instance, for prompting the user to select the views they want to write to the file system.
JavaScript
2
star
61

assemble-contrib-toc-example

Example for generating a Table of Contents using Assemble.
JavaScript
2
star
62

assemble-reload-views

Assemble instance plugin that reloads views when options are updated or when another plugin is loaded.
JavaScript
2
star
63

assemble-boilerplate-h5bp

Assemble boilerplate for launching projects with H5BP (https://github.com/h5bp/boilerplate-h5bp)
JavaScript
2
star
64

assemble-collection

Assemble plugin for creating paginated lists of files using file front matter.
JavaScript
2
star
65

assemble-hekyll

Assemble plugin for building a hekyll theme (Jekyll theme converted to handlebars).
JavaScript
2
star
66

plugins

Collection of contrib plugins maintained by the Assemble core team.
JavaScript
2
star
67

assemble-contrib-anchors-example

Usage examples for assemble-contrib-anchors, an Assemble plugin for generating adding anchors to headings.
JavaScript
2
star
68

assemble-remarkable

Assemble pipeline plugin for remarkable, the markdown converter for node.js. Can also be used with gulp.
JavaScript
1
star
69

assemble-scaffold

Assemble plugin for generating project scaffolds.
JavaScript
1
star
70

assemble-contrib-lunr-examples

Usages examples for assemble-contrib-lunr, a search plugin for Assemble.
JavaScript
1
star
71

assemble-middleware-buffer

Buffer files into a specified array on the Assemble context.
JavaScript
1
star
72

assemble-compile-file

WIP. Assemble plugin for compiling views (in a vinyl pipeline) that might need to be rendered more than once.
JavaScript
1
star