Permalink
Browse files

lint, update changelog

  • Loading branch information...
1 parent 51489ea commit bd68fc2a17a1525f7064e3318edd6120b12ba236 @jonschlinkert jonschlinkert committed Jul 21, 2016
Showing with 66 additions and 24 deletions.
  1. +1 −0 .travis.yml
  2. +52 −20 .verb.md
  3. +12 −0 changelog.md
  4. +1 −4 index.js
View
@@ -1,6 +1,7 @@
sudo: false
language: node_js
node_js:
+ - '6'
- '5'
- '4'
- '0.12'
View
@@ -1,21 +1,29 @@
-# {%= name %} {%= badge("fury") %} {%= badge("travis") %}
+<p align="center">
+ <a href="https://github.com/assemble/assemble">
+ <img height="250" width="250" src="https://raw.githubusercontent.com/assemble/assemble/master/docs/logo.png">
+ </a>
+</p>
+
+# {%= name %}
+
+{%= badge("fury") %} {%= badge('downloads') %} {%= ifExists(["test", "test.js"], badge('travis')) %} {%= badge('gitter') %}
> {%= description %}
Welcome to Assemble! We're happy to announce the release of Assemble v{%= version %}! If you're new to assemble, the [About](#about) section and [FAQ](#faq) might be a good place to start.
-You might also be interested in other members of the assemble family: [generate][], [verb][] and [update][].
-
**Get in touch!**
Have questions, suggestions, or want to discuss assemble? Join the conversation on [gitter](http://gitter.im/assemble/assemble) or give us a shout on [twitter](https://twitter.com/assemblejs). The assemble team and community are always happy to help!
+**Contributing**
+
+Please read our [contributing guide](.github/contributing.md) if you'd like to learn more about contributing to this project.
+
## Table of Contents
<!-- toc -->
-## About
-
-### What is Assemble?
+## What is Assemble?
Assemble makes it easy to create, customize, generate and maintain complete web projects. Here are some highlights:
@@ -27,17 +35,27 @@ Assemble makes it easy to create, customize, generate and maintain complete web
* **Easy to extend**: Extremely pluggable and easy to extend with helpers, plugins, routes, middleware or engines.
* **Data**: Use any data source for rendering templates, making it easy to begin a project using mock data and switch "live" data source later on.
+### Developer toolkit
+
+Assemble can be used standalone, or alongside the following libraries as part of a build workflow:
+
+- [generate][]: create projects
+- [assemble][]: build projects
+- [verb][]: document projects
+- [update][]: maintain projects
+
+All of these applications are built on [base][].
### Why assemble?
**Why should I use assemble, instead of X?**
-* Granular [control over context](docs/why-assemble#context)
+* Powerful flow control using [gulp][]-style [tasks](docs/tasks.md)
* Use [middleware](docs/middleware.md) at any point in the [render cycle](docs/render-cycle.md)
-* Flow control using [gulp][]-style [tasks](docs/tasks.md)
-* Built with [base][]. Learn assemble and you'll know how to use [verb][], [generate][], [update][] and other [base][] apps.
-* [Plugin ecosystem](docs/why-assemble#context)
+* Granular [control over context](docs/why-assemble#context)
+* [Plugin ecosystem](docs/why-assemble#plugin-ecosystem): Use plugins from any [base][] application
* Facilitates the use of _modular, encapsulated components_ in your markup, like pages, partials and layouts, resulting in consistent design across your projects.
+* Built using [base][]. By learning how to use assemble, you'll also learn how to work with [verb][], [generate][], [update][] and other [base][] apps.
* Functional, expressive API
* Intuitive CLI, with commands that map elegantly to API methods and conventions
@@ -73,6 +91,16 @@ $ npm install --global assemble
This adds `assemble` to your system path, allowing it to be run from any directory.
+
+### assemblefile.js
+
+If you'd like to see how assemble works, run `assemble`
+
+
+TODO...
+
+
+
## Getting started
**Example**
@@ -433,7 +461,9 @@ app.task('watch', function() {
});
```
-## Discovering plugins
+## Plugins
+
+### Discovering plugins
Plugins from any applications built on [base][] should work with Assemble and can be used in your `assemblefile.js`:
@@ -444,17 +474,18 @@ Plugins from any applications built on [base][] should work with Assemble and ca
* [update][update-plugin]: find update plugins on npm using the `updateplugin` keyword
* [verb][verb-plugin]: find verb plugins on npm using the `verbplugin` keyword
-## Authoring plugins
+### Authoring plugins
Visit the [plugin documentation](docs/plugins.md) guide to learn how to use, author and publish plugins.
-## More information
+## Learning
+### More information
* [Documentation](docs)
* [API documentation](docs/api)
* [Generaters maintained by the core team](https://github.com/generate)
-## FAQ
+### FAQ
**Website is outdated and being refactored!**
@@ -486,13 +517,14 @@ This is a long way of saying, you can find ways to make gulp work, but you would
Please read our [gulp FAQ](docs/src/subjects/gulp-faq.md) for more information.
-## Related projects
+## About
+### Related projects
You might also be interested in these projects from [@doowb](https://github.com/doowb) and [@jonschlinkert](https://github.com/jonschlinkert):
{%= related(verb.related.list) %}
-## Similar projects
+### Similar projects
If assemble doesn't do what you need, there are some other great open source projects you might be interested in, created by our friends on GitHub (in alphabetical order):
@@ -509,10 +541,10 @@ If assemble doesn't do what you need, there are some other great open source pro
- [ghost](https://github.com/TryGhost/Ghost)
-## Release history
+### Release history
{%= docs("changelog.md") %}
-## Contributing
+### Contributing
{%= include("contributing") %}
If Assemble doesn't do what you need, [please let us know]({%= issue({
@@ -521,7 +553,7 @@ If Assemble doesn't do what you need, [please let us know]({%= issue({
owner: "assemble"
}) %})
-## Authors
+### Authors
**Jon Schlinkert**
@@ -533,7 +565,7 @@ If Assemble doesn't do what you need, [please let us know]({%= issue({
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)
-## License
+### License
{%= copyright() %}
{%= license %}
View
@@ -1,3 +1,13 @@
+#### key
+
+Changelog entries are classified using the following labels _(from [keep-a-changelog][]_):
+
+- `added`: for new features
+- `changed`: for changes in existing functionality
+- `deprecated`: for once-stable features removed in upcoming releases
+- `removed`: for deprecated features removed in this release
+- `fixed`: for any bug fixes
+
### v0.16.1
- bump dependencies. In particular, there was a bug in [parser-front-matter][] where leading whitespace was removed after extracting front-matter, which caused the first line of indentation to be removed. This has been fixed.
@@ -61,3 +71,5 @@ Bumps [assemble-core][] to v0.22.0 to take advantage of fixes and improvements t
### v0.6.0
- Major refactor. Assemble was completely re-written from the ground-up as a standalone node.js library and is no longer a grunt plugin. Grunt plugin support has been moved to [grunt-assemble][]. Please see that repo for additional details.
+
+[keep-a-changelog]: https://github.com/olivierlacan/keep-a-changelog
View
@@ -144,10 +144,7 @@ Assemble.initViews = function(app) {
});
app.create('pages', {
- engine: app.options.engine || 'hbs',
- renameKey: function(fp) {
- return fp;
- }
+ engine: app.options.engine || 'hbs'
});
};

0 comments on commit bd68fc2

Please sign in to comment.