Permalink
Browse files

update docs

  • Loading branch information...
1 parent c15cd3e commit 880a8f426aba2d759592c8a47ce4f07e03fb9e2d @jonschlinkert jonschlinkert committed Dec 29, 2016
Showing with 141 additions and 32 deletions.
  1. +59 −10 .verb.md
  2. +76 −22 README.md
  3. +6 −0 changelog.md
View
@@ -10,26 +10,64 @@
Looking for the grunt plugin? Please visit [grunt-assemble][].
-**Jump to**
+_(Note that the current website assemble.io, is for [grunt-assemble][]. Thanks for your patience while we work on updating the site with documentation for the latest assemble)_.
-- [What is assemble?](#what-is-assemble)
-- [Who uses assemble?](#who-uses-assemble)
-- [Getting started](#getting-started)
+## Quickstart
+
+Create a new assemble project in less than 3 minutes!
+
+### Install assemble
+
+Install assemble's CLI globally:
+
+```sh
+$ npm install --global assemble
+```
+
+This adds the `assemble` command to your system path, allowing it to be run from any directory.
+
+### Create a new project
+
+Scaffold out a new assemble project using [generate-assemble][] (a project generator, powered by [generate][]).
+
+**Install generate-assemble**
+
+```sh
+$ npm install --global generate generate-assemble
+```
+
+**Scaffold out a new assemble project**
+
+```sh
+$ gen assemble
+```
+
+### Run assemble
+
+Time to build your assemble project!
+
+```sh
+$ assemble
+```
+
+This will give you a preview of how assemble works, continue reading for more information and documentation.
-_(Note that the current website assemble.io, is for [grunt-assemble][]. Thanks for your patience while we work on updating the site with documentation for the latest assemble)_.
## Table of contents
<!-- toc -->
## Overview
+### What is Assemble?
+
+Assemble is a command line tool and developer framework for rapid prototyping, static site generation, and [much more](#what-can-i-do-with-assemble).
+
### Who uses assemble?
Assemble is used by thousands of developers and teams in more than 170 countries! Here are a few examples of sites built with assemble:
- [Airbus Group](http://www.airbusgroup.com/int/en.html)
-- [hillaryclinton.com](https://www.hillaryclinton.com/)
- [Diebold](http://www.diebold.com/)
- [Transformicons](http://www.transformicons.com/)
- [Barrel](https://www.barrelny.com/)
@@ -45,13 +83,21 @@ Assemble is used by thousands of developers and teams in more than 170 countries
Is your website, blog or project built with assemble? Please [let us know about it](../../issues/300)!
-### What is assemble?
+### Why should I use assemble?
+
+* Expressive, functional API (the API is also stable)
+* You can use assemble with any web framework or CSS/HTML toolkit
+* Assemble can build static sites or hybrid static/dynamic sites
+* Streams support, you can run any [gulp][] plugin
+* [Powerful features](#features) for rapid web development, including a robust API for rendering templates with any node.js template engine.
+* Assemble can use any [base][] plugin
+* Assemble can do anything Jekyll does, but with more flexibility and control
+* Like gulp, assemble can also run **any** other static site generator as a plugin, which means you can do anything and everything all other node.js static site generators can do, and much more.
-Assemble is a command line tool and developer framework that can be used for
+### What can I do with Assemble?
* Rapid prototyping
-* An alternative to jekyll
-* Static site generation: [hillaryclinton.com](https://medium.com/git-out-the-vote/fear-and-page-loading-on-the-campaign-trail-7163ed42e6d0#.i512hhdxv) was built with Assemble
+* Static site generation (more powerful alternative to jekyll)
* Landing pages
* A/B testing
* [blogs](examples/blog)
@@ -78,6 +124,7 @@ Assemble can be used standalone, but it's even more powerful when used alongside
Here are just a few of the features assemble offers:
+* Intuitive CLI
* Full support for [gulp][] and [base][] plugins
* Assemble templates are [vinyl][] files
* Render templates with any [template engine](#engine), including [nunjucks][assemble-nunjucks], [handlebars][engine-handlebars], [lodash][engine-lodash] and any consolidate engine!
@@ -714,6 +761,7 @@ If Assemble doesn't do what you need, [please let us know]({%= issue({
[engine-handlebars]: [jon]engine-handlebars
[engine-lodash]: [jon]engine-lodash
[engine-base]: [jon]engine-base
+[doowb]: [github]doowb/
[jon]: [github]jonschlinkert/
[assemble]: [github]assemble/
[github]: https://github.com/
@@ -725,3 +773,4 @@ If Assemble doesn't do what you need, [please let us know]({%= issue({
[getting-started]: https://github.com/generate/getting-started
[templates-plugin]: https://www.npmjs.com/browse/keyword/templatesplugin
[verb-plugin]: https://www.npmjs.com/browse/keyword/verbplugin
+[hc]: https://medium.com/git-out-the-vote/fear-and-page-loading-on-the-campaign-trail-7163ed42e6d0#.mzg6dkvhb
View
@@ -7,23 +7,59 @@
# assemble
-[![NPM version](https://img.shields.io/npm/v/assemble.svg?style=flat)](https://www.npmjs.com/package/assemble) [![NPM downloads](https://img.shields.io/npm/dm/assemble.svg?style=flat)](https://npmjs.org/package/assemble) [![Build Status](https://img.shields.io/travis/assemble/assemble.svg?style=flat)](https://travis-ci.org/assemble/assemble) [![Gitter](https://badges.gitter.im/join_chat.svg)](https://gitter.im/assemble/assemble)
+[![NPM version](https://img.shields.io/npm/v/assemble.svg?style=flat)](https://www.npmjs.com/package/assemble) [![NPM monthly downloads](https://img.shields.io/npm/dm/assemble.svg?style=flat)](https://npmjs.org/package/assemble) [![Build Status](https://img.shields.io/travis/assemble/assemble.svg?style=flat)](https://travis-ci.org/assemble/assemble) [![Gitter](https://badges.gitter.im/join_chat.svg)](https://gitter.im/assemble/assemble)
Looking for the grunt plugin? Please visit [grunt-assemble](https://github.com/assemble/grunt-assemble).
-**Jump to**
+_(Note that the current website assemble.io, is for [grunt-assemble](https://github.com/assemble/grunt-assemble). Thanks for your patience while we work on updating the site with documentation for the latest assemble)_.
-* [What is assemble?](#what-is-assemble)
-* [Who uses assemble?](#who-uses-assemble)
-* [Getting started](#getting-started)
+## Quickstart
-_(Note that the current website assemble.io, is for [grunt-assemble](https://github.com/assemble/grunt-assemble). Thanks for your patience while we work on updating the site with documentation for the latest assemble)_.
+Create a new assemble project in less than 3 minutes!
+
+### Install assemble
+
+Install assemble's CLI globally:
+
+```sh
+$ npm install --global assemble
+```
+
+This adds the `assemble` command to your system path, allowing it to be run from any directory.
+
+### Create a new project
+
+Scaffold out a new assemble project using [generate-assemble][] (a project generator, powered by [generate](https://github.com/generate/generate)).
+
+**Install generate-assemble**
+
+```sh
+$ npm install --global generate generate-assemble
+```
+
+**Scaffold out a new assemble project**
+
+```sh
+$ gen assemble
+```
+
+### Run assemble
+
+Time to build your assemble project!
+
+```sh
+$ assemble
+```
+
+This will give you a preview of how assemble works, continue reading for more information and documentation.
## Table of contents
- [Overview](#overview)
+ * [What is Assemble?](#what-is-assemble)
* [Who uses assemble?](#who-uses-assemble)
- * [What is assemble?](#what-is-assemble)
+ * [Why should I use assemble?](#why-should-i-use-assemble)
+ * [What can I do with Assemble?](#what-can-i-do-with-assemble)
* [Rapid development toolkit](#rapid-development-toolkit)
* [Features](#features)
- [Getting started](#getting-started)
@@ -72,12 +108,15 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](
## Overview
+### What is Assemble?
+
+Assemble is a command line tool and developer framework for rapid prototyping, static site generation, and [much more](#what-can-i-do-with-assemble).
+
### Who uses assemble?
Assemble is used by thousands of developers and teams in more than 170 countries! Here are a few examples of sites built with assemble:
* [Airbus Group](http://www.airbusgroup.com/int/en.html)
-* [hillaryclinton.com](https://www.hillaryclinton.com/)
* [Diebold](http://www.diebold.com/)
* [Transformicons](http://www.transformicons.com/)
* [Barrel](https://www.barrelny.com/)
@@ -93,13 +132,21 @@ Assemble is used by thousands of developers and teams in more than 170 countries
Is your website, blog or project built with assemble? Please [let us know about it](../../issues/300)!
-### What is assemble?
+### Why should I use assemble?
+
+* Expressive, functional API (the API is also stable)
+* You can use assemble with any web framework or CSS/HTML toolkit
+* Assemble can build static sites or hybrid static/dynamic sites
+* Streams support, you can run any [gulp](http://gulpjs.com) plugin
+* [Powerful features](#features) for rapid web development, including a robust API for rendering templates with any node.js template engine.
+* Assemble can use any [base](https://github.com/node-base/base) plugin
+* Assemble can do anything Jekyll does, but with more flexibility and control
+* Like gulp, assemble can also run **any** other static site generator as a plugin, which means you can do anything and everything all other node.js static site generators can do, and much more.
-Assemble is a command line tool and developer framework that can be used for
+### What can I do with Assemble?
* Rapid prototyping
-* An alternative to jekyll
-* Static site generation: [hillaryclinton.com](https://medium.com/git-out-the-vote/fear-and-page-loading-on-the-campaign-trail-7163ed42e6d0#.i512hhdxv) was built with Assemble
+* Static site generation (more powerful alternative to jekyll)
* Landing pages
* A/B testing
* [blogs](examples/blog)
@@ -126,8 +173,9 @@ Assemble can be used standalone, but it's even more powerful when used alongside
Here are just a few of the features assemble offers:
+* Intuitive CLI
* Full support for [gulp](http://gulpjs.com) and [base](https://github.com/node-base/base) plugins
-* Assemble templates are [vinyl](http://github.com/gulpjs/vinyl) files
+* Assemble templates are [vinyl](https://github.com/gulpjs/vinyl) files
* Render templates with any [template engine](#engine), including [nunjucks](https://github.com/assemble/assemble-nunjucks), [handlebars](https://github.com/jonschlinkert/engine-handlebars), [lodash](https://github.com/jonschlinkert/engine-lodash) and any consolidate engine!
* Use multiple engines, assemble can detect the one to use based on file extension
* [helpers](#helpers): support for sync and async
@@ -136,7 +184,7 @@ Here are just a few of the features assemble offers:
* Partials/includes
* [Layouts](https://github.com/doowb/layouts)
* Pagination
-* [permalinks][assemble-permalinks]
+* [permalinks](https://github.com/assemble/assemble-permalinks)
* [middleware](#middleware) can be used to tranform files at any stage in the render cycle
* Generate pages from JSON
* Much more!
@@ -328,17 +376,17 @@ $ assemble --file assemblefile.dev.js
Create an `assemble` app. This is the main function exported by the assemble module.
-**Params**
-
-* `options` **{Object}**: Optionally pass default options to use.
-
**Example**
```js
var assemble = require('assemble');
var app = assemble();
```
+**Params**
+
+* `options` **{Object}**: Optionally pass default options to use.
+
### Templates API
Assemble exposes the entire API from the [templates](https://github.com/jonschlinkert/templates) library for working with templates and template collections. The API is much more extensive than what is documented here, see [templates](https://github.com/jonschlinkert/templates) for more documentation.
@@ -348,7 +396,7 @@ Assemble exposes the entire API from the [templates](https://github.com/jonschli
In the following documentation, the terms "template" and "view" both refer to _aspects_ of the same thing. Here's what they mean:
* `template`: an actual template string
-* `view`: a object with a `content` property that contains the template string. Since views are instances of [vinyl](http://github.com/gulpjs/vinyl), you can think of a view as a "vinyl file for templates".
+* `view`: a object with a `content` property that contains the template string. Since views are instances of [vinyl](https://github.com/gulpjs/vinyl), you can think of a view as a "vinyl file for templates".
#### .create
@@ -489,7 +537,7 @@ Assemble has first-class support for [vinyl-fs](http://github.com/wearefractal/v
#### .src
-Create a [vinyl](http://github.com/gulpjs/vinyl) stream. Takes glob patterns or filepaths to the source files to read.
+Create a [vinyl](https://github.com/gulpjs/vinyl) stream. Takes glob patterns or filepaths to the source files to read.
**Params**
@@ -749,6 +797,12 @@ Custom labels used in this changelog:
* `dependencies`: bumps dependencies
* `housekeeping`: code re-organization, minor edits, or other changes that don't fit in one of the other categories.
+### v0.18.0
+
+**Dependencies**
+
+* bumps [assemble-core](https://github.com/assemble/assemble-core) to 0.27.0
+
### v0.17.0
**Dependencies**
@@ -842,8 +896,8 @@ If Assemble doesn't do what you need, [please let us know](https://github.com/un
### License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
-Released under the [MIT license](https://github.com/assemble/assemble/blob/master/LICENSE).
+Released under the [MIT license](LICENSE).
***
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on August 10, 2016._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.1, on December 29, 2016._
View
@@ -13,6 +13,12 @@ Custom labels used in this changelog:
* `dependencies`: bumps dependencies
* `housekeeping`: code re-organization, minor edits, or other changes that don't fit in one of the other categories.
+### v0.18.0
+
+**Dependencies**
+
+- bumps [assemble-core][] to 0.27.0
+
### v0.17.0
**Dependencies**

0 comments on commit 880a8f4

Please sign in to comment.