https://github.com/assemble/assemble-pattern-lab
An easier-to-use, cleaner and more extensible build system for pattern-lab.
https://github.com/assemble/assemble-pattern-lab
Last synced: 11 months ago
JSON representation
An easier-to-use, cleaner and more extensible build system for pattern-lab.
- Host: GitHub
- URL: https://github.com/assemble/assemble-pattern-lab
- Owner: assemble
- License: other
- Created: 2014-03-15T17:04:59.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-03-17T10:02:11.000Z (about 12 years ago)
- Last Synced: 2025-06-02T17:25:40.317Z (about 1 year ago)
- Language: JavaScript
- Size: 1.09 MB
- Stars: 26
- Watchers: 12
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE-CC
Awesome Lists containing this project
README
# assemble-pattern-lab [](http://badge.fury.io/js/assemble-pattern-lab)
> An easier-to-use and more extensible build system for pattern-lab.
This project uses [Assemble](https://github.com/assemble/assemble) to build projects with [pattern lab](http://pattern-lab.info/) conventions.
Note that _this isn't 100% feature complete, and the focus was mostly on implementing the patterns - not the actual demo site_, but this project does implement the actual patterns, e.g. the important parts, and you can easily add (or [request](https://github.com/jonschlinkert/assemble-pattern-lab/issues)) any functionality you require.
Also, there are a few differences in how this project handles templates. Instead of having to namespace partials, like `{{> organisms-latest-posts }}`, and then using a complex regex system for dynamically renaming these partials according to how they are organized in folders, here you can simply use `{{organism "latest-posts"}}`.
This has several advantages:
* Store your patterns wherever you want them, just tell Assemble where they are.
* We're adhering to mustache/handlebars conventions instead of working around them.
* We can easily extend and add new patterns, or allow metadata to be passed as context to templates and so on.
## Getting Started
### Download Options
* Either [download the project]({https://github.com/assemble/assemble-pattern-lab/archive/master.zip}) from GitHub, or
* Use git to clone the project: `git clone https://github.com/assemble/assemble-pattern-lab.git`
### Install dependencies
Install the necessary dependencies, including Assemble and Grunt:
```bash
npm i
```
### Build
With everything downloaded and installed, build the project by running:
```bash
grunt assemble
```
## Usage
The following patterns have been implements:
* `atoms`: used in templates with `{{atoms "foo"}}`
* `molecules`: used in templates with `{{molecules "foo"}}`
* `organisms`: used in templates with `{{organisms "foo"}}`
* `templates`: used in templates with `{{templates "foo"}}`
* `pages`: Pages are specified using `src` property or `files` object/arrays in the Gruntfile config (see below)
For any templates to actually be found during the build, you'll have to first tell Assemble where to find them in Gruntfile, like so:
```js
assemble: {
options: {
// Pattern Lab templates
patterns: {
atoms: ['src/atoms/**/*.hbs'],
molecules: ['src/molecules/**/*.hbs'],
organisms: ['src/organisms/**/*.hbs'],
templates: ['src/templates/**/*.hbs'],
}
},
site: {
// `pages` are defined here (you can use any of the Grunt files
// patterns, e.g. src-dest, files object, files array, etc)
files: {
'_gh_pages/': ['src/pages/*.hbs']
}
}
}
```
## Contributing
All contributions are welcome! If you like the project, _stars and tweets_ are a great way to show your support. If you want to take a more active role and help with documentation, writing unit tests, addressing issues or whatever seems interesting, please let us know, we'd be happy to help you get started!
Also, we use [Verb](https://github.com/assemble/verb) for documentation, so don't edit the readme or other docs directly. Please edit the templates in the [docs directory](./docs) and then run `verb` to build them before you do a pull request. Thanks!
## Authors
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT, Creative Commons Attribution 3.0 Unported License licenses
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 17, 2014._