-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Erik Jung
committed
Apr 18, 2016
1 parent
1eee06a
commit 23b4706
Showing
1 changed file
with
1 addition
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,104 +1 @@ | ||
| [](https://travis-ci.org/fbrctr/fabricator) [](https://david-dm.org/fbrctr/fabricator#info=devDependencies) [](https://gitter.im/fbrctr/fabricator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
|
|
||
| <p align="center"> | ||
| <img src="http://fbrctr.github.io/assets/toolkit/images/logo.svg" width="500"> | ||
| </p> | ||
|
|
||
| # Fabricator | ||
|
|
||
| > _fabricate_ - to make by assembling parts or sections. | ||
| Fabricator is a tool for building website UI toolkits - _think ["Tiny Bootstraps, for Every Client"](http://daverupert.com/2013/04/responsive-deliverables/#tiny-bootstraps-for-every-client)_ | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ```shell | ||
| $ curl -L https://github.com/resource/fabricator/archive/master.tar.gz | tar zx --strip 1 | ||
| $ npm start | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| #### [Read the docs →](http://fbrctr.github.io/docs) | ||
|
|
||
| ## Demo | ||
|
|
||
| #### [Default Fabricator Instance →](http://fbrctr.github.io/demo) | ||
|
|
||
| ## Credits | ||
|
|
||
| Created by [Luke Askew](http://twitter.com/lukeaskew). | ||
|
|
||
| Logo by [Abby Putinski](https://abbyputinski.com/) | ||
|
|
||
| ## License | ||
|
|
||
| [The MIT License (MIT)](http://opensource.org/licenses/mit-license.php) | ||
|
|
||
| ## Cloud Four Additions and Changes | ||
|
|
||
| We've made some changes and enhancements of our own. The presentation of the fabricator UI has been modified quite a bit. Also...: | ||
|
|
||
| ### Handlebars Helpers | ||
|
|
||
| We've added additional available Handlebars (template) helpers. See `build/helpers` for source. | ||
|
|
||
| ### Additional Front-Matter Metadata | ||
|
|
||
| You can of course add any front matter you like to materials. We've added specific support in templates for some special attributes: | ||
|
|
||
| `links`: This is an object. Keys will be used for display, values should be the URL. These will be rendered along with the material as resource/reference external links. | ||
|
|
||
| Example: | ||
|
|
||
| ```yaml | ||
| --- | ||
| links: | ||
| The Best Web Site Ever: http://www.example.com | ||
| Another site: https://www.foo.com | ||
| --- | ||
| ``` | ||
|
|
||
| `labels`: This is an array. Values of the array will be used as label class identifiers. Labels express the status of the material in question. Unrecognized labels will be displayed as well, but without color highlighting (in current implementation, gray). | ||
|
|
||
| Defined labels: | ||
|
|
||
| * `inprogress` (yellow) | ||
| * `deprecated` (red) | ||
| * `approved` (green) | ||
|
|
||
| Example: | ||
|
|
||
| ```yaml | ||
| --- | ||
| labels: | ||
| - inprogress | ||
| - totoro | ||
| --- | ||
| ``` | ||
|
|
||
| `stylesheets`: This is an array. Values of this array will be included in the page `<head>` of the view when using the `default` layout. | ||
|
|
||
| Example: | ||
|
|
||
| ```yaml | ||
| --- | ||
| stylesheets: | ||
| - example | ||
| --- | ||
| ``` | ||
|
|
||
| Result: | ||
|
|
||
| ```html | ||
| <link rel="stylesheet" href="/assets/toolkit/styles/example.css"> | ||
| ``` | ||
|
|
||
| ### Workflow Changes | ||
|
|
||
| * We've opted for `post-css` instead of the default Sass that ships with Fabricator. | ||
| * We've removed `csso` (optimization). | ||
| * We've added a new Gulp task: `styles:test` | ||
| - This analyzes CSS files using [postcss-bem-linter](https://github.com/postcss/postcss-bem-linter) | ||
| - Any issues found are output as console warnings with [postcss-reporter](https://github.com/postcss/postcss-reporter) | ||
| * There's also a new `modernizr` task. Any [Modernizr v3](http://v3.modernizr.com/) tests referenced via CSS or JS files will be automatically included thanks to [gulp-modernizr](https://github.com/doctyper/gulp-modernizr). | ||
| # cloudfour.com pattern library |