docs - more cleanup

Author: sindresorhus

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="http://gulpjs.com">
-    <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"/>
+    <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
   </a>
 </p>
 
@@ -19,9 +19,8 @@ For a Getting started guide, API docs, recipes, making a plugin, etc. see the [d
 
 This file is just a quick sample to give you a taste of what gulp does.
 
-```javascript
+```js
 var gulp = require('gulp');
-
 var coffee = require('gulp-coffee');
 var concat = require('gulp-concat');
 var uglify = require('gulp-uglify');
@@ -69,7 +68,6 @@ gulp.task('watch', function() {
 
 // The default task (called when you run `gulp` from cli)
 gulp.task('default', ['watch', 'scripts', 'images']);
-
 ```
 
 ## Incremental Builds

docs/API.md

@@ -2,13 +2,13 @@
 
 ### gulp.src(globs[, options])
 
-Takes a glob and represents a file structure. Can be piped to plugins.  
+Takes a glob and represents a file structure. Can be piped to plugins.
 
-```javascript
-gulp.src('./client/templates/*.jade')
-    .pipe(jade())
-    .pipe(minify())
-    .pipe(gulp.dest('./build/minified_templates'));
+```js
+gulp.src('client/templates/*.jade')
+  .pipe(jade())
+  .pipe(minify())
+  .pipe(gulp.dest('build/minified_templates'));
 ```
 
 `glob` refers to [node-glob syntax](https://github.com/isaacs/node-glob) or it can be a direct file path.
@@ -37,7 +37,6 @@ Default: `true`
 
 Setting this to `false` will return `file.contents` as null and not read the file at all.
 
-
 ### gulp.dest(path)
 
 Can be piped to and it will write files. Re-emits all data passed to it so you can pipe to multiple folders.  Folders that don't exist will be created.
@@ -55,12 +54,11 @@ Type: `String`
 
 The path (folder) to write files to.
 
-
 ### gulp.task(name[, deps], fn)
 
 Define a task using [Orchestrator].
 
-```javascript
+```js
 gulp.task('somename', function() {
   // Do stuff
 });
@@ -75,14 +73,13 @@ Type: `Array`
 
 An array of tasks to be executed and completed before your task will run.
 
-```javascript
+```js
 gulp.task('mytask', ['array', 'of', 'task', 'names'], function() {
   // Do stuff
 });
 ```
 
-**Note:** Are your tasks running before the dependencies are complete?  Make sure your dependency tasks
-are correctly using the async run hints: take in a callback or return a promise or event stream.
+**Note:** Are your tasks running before the dependencies are complete?  Make sure your dependency tasks are correctly using the async run hints: take in a callback or return a promise or event stream.
 
 #### fn
 
@@ -95,24 +92,24 @@ Tasks can be made asynchronous if its `fn` does one of the following:
 ##### Accept a callback
 
 ```javascript
-// Run a command in a shell 
+// run a command in a shell
 var exec = require('child_process').exec;
 gulp.task('jekyll', function(cb) {
-  // Build Jekyl
-  exec('jekyll build', function(err) { 
-    if (err) return cb(err); //return error
+  // build Jekyll
+  exec('jekyll build', function(err) {
+    if (err) return cb(err); // return error
     cb(); // finished task
   });
 });
 ```
 
 ##### Return a stream
 
-```javascript
+```js
 gulp.task('somename', function() {
-  var stream = gulp.src('./client/**/*.js')
+  var stream = gulp.src('client/**/*.js')
     .pipe(minify())
-    .pipe(gulp.dest('/build'));
+    .pipe(gulp.dest('build'));
   return stream;
 });
 ```
@@ -125,7 +122,7 @@ var Q = require('q');
 gulp.task('somename', function() {
   var deferred = Q.defer();
 
-  // Do async stuff
+  // do async stuff
   setTimeout(function() {
     deferred.resolve();
   }, 1);
@@ -134,8 +131,7 @@ gulp.task('somename', function() {
 });
 ```
 
-**Note:** By default, tasks run with maximum concurrency -- e.g. it launches all the tasks at once and waits for nothing.
-If you want to create a series where tasks run in a particular order, you need to do two things:
+**Note:** By default, tasks run with maximum concurrency -- e.g. it launches all the tasks at once and waits for nothing. If you want to create a series where tasks run in a particular order, you need to do two things:
 
 - give it a hint to tell it when the task is done,
 - and give it a hint that a task depends on completion of another.
@@ -149,7 +145,7 @@ done or return a promise or stream that the engine should wait to resolve or end
 
 So this example would look like this:
 
-```javascript
+```js
 var gulp = require('gulp');
 
 // takes in a callback so the engine knows when it'll be done
@@ -188,10 +184,10 @@ Type: `Array`
 
 Names of task(s) to run when a file changes, added with `gulp.task()`
 
-```javascript
+```js
 var watcher = gulp.watch('js/**/*.js', ['uglify','reload']);
 watcher.on('change', function(event) {
-  console.log('File '+event.path+' was '+event.type+', running tasks...');
+  console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
 });
 ```
 
@@ -212,9 +208,9 @@ Type: `Function`
 
 Callback to be called on each change.
 
-```javascript
+```js
 gulp.watch('js/**/*.js', function(event) {
-  console.log('File '+event.path+' was '+event.type+', running tasks...');
+  console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
 });
 ```
 

docs/CLI.md

@@ -14,7 +14,7 @@ gulp has very few flags to know about. All other flags are for tasks to use if n
 - `--no-color` will force gulp and gulp plugins to not display colors even when color support is detected
 - `--silent` will disable all gulp logging
 
-The CLI adds process.env.INIT_CWD which is the original cwd it was launched from
+The CLI adds process.env.INIT_CWD which is the original cwd it was launched from.
 
 ### Tasks
 

docs/README.md

@@ -5,18 +5,22 @@
 * [CLI documentation](CLI.md) - Learn how to call tasks and use compilers
 * [Writing a Plugin](writing-a-plugin/README.md) - So you're writing a gulp plugin? Go here for the essential dos and don'ts.
 
+
 ## FAQ
 
-See [the FAQ](FAQ.md) for the answers to commonly asked questions.
+See the [FAQ](FAQ.md) for the answers to commonly asked questions.
+
 
 ## Recipes
 
-The community has compiled guides on how to use gulp for common use cases. Check out the [recipes folder](recipes) for a full list.
+The community has written [recipes](recipes) common gulp use-cases.
+
 
 ## Still got questions?
 
 Post on [StackOverflow with a #gulp tag](http://stackoverflow.com/questions/tagged/gulp), or come chat with us in [#gulpjs](http://webchat.freenode.net/?channels=gulpjs) on [Freenode](http://freenode.net/).
 
+
 ## Articles
 * [Tagtree intro to gulp video](http://tagtree.tv/gulp)
 * [Introduction to node.js streams](https://github.com/substack/stream-handbook)
@@ -29,6 +33,7 @@ Post on [StackOverflow with a #gulp tag](http://stackoverflow.com/questions/tagg
 * [Gulp - The Basics (screencast)](https://www.youtube.com/watch?v=dwSLFai8ovQ)
 * [Get started with gulp (video series)](http://www.youtube.com/playlist?list=PLRk95HPmOM6PN-G1xyKj9q6ap_dc9Yckm)
 
+
 ## License
 
 All the documentation is covered by the CC0 license *(do whatever you want with it - public domain)*.

docs/getting-started.md

@@ -1,31 +1,31 @@
-## Getting Started
+# Getting Started
 
-### 1. Install gulp globally:
+#### 1. Install gulp globally:
 
-```
-npm install -g gulp
+```sh
+$ npm install --global gulp
 ```
 
-### 2. Install gulp in your project devDependencies:
+#### 2. Install gulp in your project devDependencies:
 
-```
-npm install --save-dev gulp
+```sh
+$ npm install --save-dev gulp
 ```
 
-### 3. Create a `gulpfile.js` at the root of your project:
+#### 3. Create a `gulpfile.js` at the root of your project:
 
-```javascript
+```js
 var gulp = require('gulp');
 
 gulp.task('default', function() {
   // place code for your default task here
 });
 ```
 
-### 4. Run gulp:
+#### 4. Run gulp:
 
-```
-gulp
+```sh
+$ gulp
 ```
 
 The default task will run and do nothing.
@@ -34,7 +34,7 @@ To run individual tasks, use `gulp <task> <othertask>`.
 
 ## Where do I go now?
 
-You have an empty gulpfile and everything is installed. How do you REALLY get started? Check out the [recipes and articles section](README.md#articles-and-recipes) for more information.
+You have an empty gulpfile and everything is installed. How do you REALLY get started? Check out the [recipes](recipes) and the [list of articles](README.md#articles) for more information.
 
 ## .src, .watch, .dest, CLI args - How do I use these things?
 

docs/writing-a-plugin/dealing-with-streams.md

@@ -15,7 +15,7 @@ var through = require('through2');
 var gutil = require('gulp-util');
 var PluginError = gutil.PluginError;
 
-// Consts
+// consts
 const PLUGIN_NAME = 'gulp-prefixer';
 
 function prefixStream(prefixText) {
@@ -24,19 +24,19 @@ function prefixStream(prefixText) {
   return stream;
 }
 
-// Plugin level function(dealing with files)
+// plugin level function (dealing with files)
 function gulpPrefixer(prefixText) {
-
   if (!prefixText) {
-    throw new PluginError(PLUGIN_NAME, "Missing prefix text!");
+    throw new PluginError(PLUGIN_NAME, 'Missing prefix text!');
   }
+
   prefixText = new Buffer(prefixText); // allocate ahead of time
 
-  // Creating a stream through which each file will pass
-  var stream = through.obj(function(file, enc, callback) {
+  // creating a stream through which each file will pass
+  var stream = through.obj(function(file, enc, cb) {
     if (file.isBuffer()) {
       this.emit('error', new PluginError(PLUGIN_NAME, 'Buffers not supported!'));
-      return callback();
+      return cb();
     }
 
     if (file.isStream()) {
@@ -51,14 +51,14 @@ function gulpPrefixer(prefixText) {
     // make sure the file goes through the next gulp plugin
     this.push(file);
     // tell the stream engine that we are done with this file
-    callback();
+    cb();
   });
 
   // returning the file stream
   return stream;
 };
 
-// Exporting the plugin main function
+// exporting the plugin main function
 module.exports = gulpPrefixer;
 ```
 
@@ -70,10 +70,10 @@ var gulpPrefixer = require('gulp-prefixer');
 
 gulp.src('files/**/*.js', { buffer: false })
   .pipe(gulpPrefixer('prepended string'))
-  .pipe(gulp.dest('/modified-files/'));
+  .pipe(gulp.dest('modified-files'));
 ```
 
 ## Some plugins using streams
 
 * [gulp-svgicons2svgfont](https://github.com/nfroidure/gulp-svgiconstosvgfont)
-* gulp-browserify (Soon)
+

docs/writing-a-plugin/guidelines.md

@@ -56,7 +56,7 @@ var through = require('through2');
 var gutil = require('gulp-util');
 var PluginError = gutil.PluginError;
 
-// Consts
+// consts
 const PLUGIN_NAME = 'gulp-prefixer';
 
 function prefixStream(prefixText) {
@@ -65,19 +65,20 @@ function prefixStream(prefixText) {
   return stream;
 }
 
-// Plugin level function(dealing with files)
+// plugin level function (dealing with files)
 function gulpPrefixer(prefixText) {
-
   if (!prefixText) {
-    throw new PluginError(PLUGIN_NAME, "Missing prefix text!");
+    throw new PluginError(PLUGIN_NAME, 'Missing prefix text!');
   }
+
   prefixText = new Buffer(prefixText); // allocate ahead of time
 
-  // Creating a stream through which each file will pass
-  var stream = through.obj(function(file, enc, callback) {
+  // creating a stream through which each file will pass
+  var stream = through.obj(function(file, enc, cb) {
     if (file.isNull()) {
-       // Do nothing if no contents
+       // do nothing if no contents
     }
+
     if (file.isBuffer()) {
         file.contents = Buffer.concat([prefixText, file.contents]);
     }
@@ -87,14 +88,14 @@ function gulpPrefixer(prefixText) {
     }
 
     this.push(file);
-    return callback();
 
+    return cb();
   });
 
   // returning the file stream
   return stream;
 };
 
-// Exporting the plugin main function
+// exporting the plugin main function
 module.exports = gulpPrefixer;
 ```

docs/writing-a-plugin/recommended-modules.md

@@ -20,5 +20,4 @@ Use [chalk](https://github.com/sindresorhus/chalk)
 
 Use [dateformat](https://github.com/felixge/node-dateformat)
 
-
-Display as `HH:MM:ss`
+Display as `HH:MM:ss`