Permalink
Browse files

convert docs to use verb

  • Loading branch information...
1 parent 96c4c22 commit d192795ea13111356b91bc276f1260bba59fa8bc @makotot makotot committed May 6, 2014
Showing with 73 additions and 4 deletions.
  1. +66 −0 .verbrc.md
  2. +1 −0 Gruntfile.js
  3. +4 −3 README.md
  4. +2 −1 package.json
View
@@ -0,0 +1,66 @@
+# {%= name %} {%= badge("fury") %}
+
+> {%= description %}
+
+### NOTICE: THIS BOILERPLATE IS BEING REFACTORED
+
+You may find outdated information or examples in this project. While we're refactoring, you might be more interested in [boilerplate-bootstrap](http://github.com/assemble/boilerplate-bootstrap) in the meantime.
+
+## Getting Started
+
+* **[Download this project][download]** and unzip it into a new folder.
+* In the project folder, run `npm install` to install [Assemble][assemble], [Grunt](http://gruntjs.com/) and any other dependencies.
+* Once the dependencies are installed you may run `grunt assemble` to build the example project.
+
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile][gruntfile], as well as install and use Grunt plugins.
+
+
+## The "assemble" task
+
+### Overview
+In the project's Gruntfile, the example `assemble` task is pre-loaded with paths and options following standard Grunt.js conventions:
+
+```js
+grunt.initConfig({
+ // The "assemble" task
+ assemble: {
+ // Task-level options.
+ options: {
+ flatten: true,
+ assets: 'dist/assets',
+ layout: 'templates/layouts/default.hbs',
+ partials: 'templates/partials/*.hbs',
+ data: 'src/data/*.{json,yml}'
+ },
+ // Templates to build into pages
+ pages: {
+ files: {
+ 'dist/': ['templates/pages/*.hbs']
+ }
+ }
+ }
+})
+```
+
+## Boilerplate Author
+
+{%= contrib("jon") %}
+
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Use [Assemble][assemble] to build and maintain your gh-pages, blog or documentation. Lint and test your code using [Grunt](http://gruntjs.com/).
+
+
+
+[download]: https://github.com/assemble/boilerplate-site/archive/master.zip
+[assemble]: https://github.com/assemble/assemble/
+[boilerplate-site]: https://github.com/assemble/boilerplate-site
+
+[wiki]: https://github.com/assemble/assemble/wiki
+[layouts]: https://github.com/assemble/assemble/wiki/layouts
+[partials]: https://github.com/assemble/assemble/wiki/partials
+[data]: https://github.com/assemble/assemble/wiki/data
+
+[gruntfile]: http://gruntjs.com/sample-gruntfile
+[configuring tasks]: http://gruntjs.com/configuring-tasks
+[tasks-and-targets]: http://gruntjs.com/configuring-tasks#task-configuration-and-targets
+[files-object]: http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
View
@@ -46,6 +46,7 @@ module.exports = function(grunt) {
// Load npm plugins to provide necessary tasks.
grunt.loadNpmTasks('assemble');
grunt.loadNpmTasks('grunt-contrib-clean');
+ grunt.loadNpmTasks('grunt-verb');
// Default task to be run.
grunt.registerTask('default', ['clean', 'assemble']);
View
@@ -1,4 +1,4 @@
-# [boilerplate-site v0.1.2](http://github.com/assemble/boilerplate-site) [![Build Status](https://travis-ci.org/assemble/boilerplate-site.png)](https://travis-ci.org/assemble/boilerplate-site)
+# boilerplate-site [![NPM version](https://badge.fury.io/js/boilerplate-site.png)](http://badge.fury.io/js/boilerplate-site)
> Boilerplate for generating a basic static site with Assemble.
@@ -44,10 +44,11 @@ grunt.initConfig({
## Boilerplate Author
+
**Jon Schlinkert**
-+ [http://github.com/jonschlinkert](http://github.com/jonschlinkert)
-+ [http://twitter.com/jonschlinkert](http://twitter.com/jonschlinkert)
++ [github/jonschlinkert](https://github.com/jonschlinkert)
++ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Use [Assemble][assemble] to build and maintain your gh-pages, blog or documentation. Lint and test your code using [Grunt](http://gruntjs.com/).
View
@@ -33,7 +33,8 @@
"devDependencies": {
"grunt": "~0.4.1",
"grunt-contrib-clean": "~0.5.0",
- "assemble": "~0.4.4"
+ "assemble": "~0.4.4",
+ "grunt-verb": "~0.2.4"
},
"licenses": [
{

0 comments on commit d192795

Please sign in to comment.