Skip to content

Commit c5af6f1

Browse files
phatedphated
committed
Docs: Remove front-matter from outdated pages
1 parent 96c353d commit c5af6f1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+2
-303
lines changed

‎docs/CLI.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: cli
3-
title: CLI
4-
hide_title: true
5-
sidebar_label: CLI
6-
-->
7-
81
## gulp CLI docs
92

103
### Flags

‎docs/FAQ.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: faq
3-
title: FAQ
4-
hide_title: true
5-
sidebar_label: FAQ
6-
-->
7-
81
# FAQ
92

103
## Why gulp? Why not ____?

‎docs/README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: docs
3-
title: Docs
4-
hide_title: true
5-
sidebar_label: Docs
6-
-->
7-
81
# gulp documentation
92

103
* [Getting Started](getting-started/) - Get started with gulp

‎docs/recipes/README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: recipes
3-
title: Recipes
4-
hide_title: true
5-
sidebar_label: Recipes
6-
-->
7-
81
# Recipes
92

103
* [Automate release workflow](automate-release-workflow.md)

‎docs/recipes/automate-release-workflow.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: automate-release-workflow
3-
title: Automate Release Workflow
4-
hide_title: true
5-
sidebar_label: Automate Release Workflow
6-
-->
7-
81
# Automate release workflow
92

103
If your project follows a semantic versioning, it may be a good idea to automatize the steps needed to do a release.

‎docs/recipes/browserify-multiple-destination.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: browserify-multiple-destination
3-
title: Browserify w/ Multiple Destinations
4-
hide_title: true
5-
sidebar_label: Browserify w/ Multiple Destinations
6-
-->
7-
81
# Browserify + Globs (multiple destination)
92

103
This example shows how to set up a task of bundling multiple entry points into multiple destinations using browserify.

‎docs/recipes/browserify-transforms.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: browserify-transforms
3-
title: Browserify + Transforms
4-
hide_title: true
5-
sidebar_label: Browserify + Transforms
6-
-->
7-
81
# Browserify + Transforms
92

103
[Browserify](https://github.com/browserify/browserify) has become an important and indispensable

‎docs/recipes/browserify-uglify-sourcemap.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: browserify-uglify-sourcemap
3-
title: Browserify + Uglify2 with Sourcemaps
4-
hide_title: true
5-
sidebar_label: Browserify + Uglify2 with Sourcemaps
6-
-->
7-
81
# Browserify + Uglify2 with sourcemaps
92

103
[Browserify](https://github.com/browserify/browserify) has become an important and indispensable

‎docs/recipes/browserify-with-globs.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: browserify-with-globs
3-
title: Browserify + Globs
4-
hide_title: true
5-
sidebar_label: Browserify + Globs
6-
-->
7-
81
# Browserify + Globs
92

103
[Browserify + Uglify2](https://github.com/gulpjs/gulp/blob/master/docs/recipes/browserify-uglify-sourcemap.md) shows how to setup a basic gulp task to bundle a JavaScript file with its dependencies, and minify the bundle with UglifyJS while preserving source maps.

‎docs/recipes/combining-streams-to-handle-errors.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: combining-streams-to-handle-errors
3-
title: Combining Streams to Handle Errors
4-
hide_title: true
5-
sidebar_label: Combining Streams to Handle Errors
6-
-->
7-
81
# Combining streams to handle errors
92

103
By default, emitting an error on a stream will cause it to be thrown unless it already has a listener attached to the `error` event. This gets a bit tricky when you're working with longer pipelines of streams.

‎docs/recipes/cron-task.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: cron-task
3-
title: Cron Task
4-
hide_title: true
5-
sidebar_label: Cron Task
6-
-->
7-
81
# Run gulp task via cron job
92

103
While logged in via a user that has privileges to run `gulp`, run the following:

‎docs/recipes/delete-files-folder.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: delete-files-folder
3-
title: Delete files and folders
4-
hide_title: true
5-
sidebar_label: Delete files and folders
6-
-->
7-
81
# Delete files and folders
92

103
You might want to delete some files before running your build. Since deleting files doesn't work on the file contents, there's no reason to use a gulp plugin. An excellent opportunity to use a vanilla node module.

‎docs/recipes/exports-as-tasks.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: export-as-tasks
3-
title: Export as Tasks
4-
hide_title: true
5-
sidebar_label: Export as Tasks
6-
-->
7-
81
# Exports as Tasks
92

103
Using the ES2015 module syntax you can use your exports as tasks.

‎docs/recipes/fast-browserify-builds-with-watchify.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: fast-browserify-builds-with-watchify
3-
title: Fast Browserify builds with Watchify
4-
hide_title: true
5-
sidebar_label: Fast Browserify builds with Watchify
6-
-->
7-
81
# Fast browserify builds with watchify
92

103
As a [browserify](https://github.com/browserify/browserify) project begins to expand, the time to bundle it slowly gets longer and longer. While it might start at 1 second, it's possible to be waiting 30 seconds for your project to build on particularly large projects.

‎docs/recipes/handling-the-delete-event-on-watch.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: handling-the-delete-event-on-watch
3-
title: Handling the Delete Event on Watch
4-
hide_title: true
5-
sidebar_label: Handling the Delete Event on Watch
6-
-->
7-
81
# Handling the Delete Event on Watch
92

103
You can listen for `'unlink'` events to fire on the watcher returned from `gulp.watch`.

‎docs/recipes/incremental-builds-with-concatenate.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: incremental-builds-with-concatenate
3-
title: Incremental Rebuilding
4-
hide_title: true
5-
sidebar_label: Incremental Rebuilding
6-
-->
7-
81
# Incremental rebuilding, including operating on full file sets
92

103
The trouble with incremental rebuilds is you often want to operate on _all_ processed files, not just single files. For example, you may want to lint and module-wrap just the file(s) that have changed, then concatenate it with all other linted and module-wrapped files. This is difficult without the use of temp files.

‎docs/recipes/maintain-directory-structure-while-globbing.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: maintain-directory-structure-while-globbing
3-
title: Maintain Directory Structure while Globbing
4-
hide_title: true
5-
sidebar_label: Maintain Directory Structure while Globbing
6-
-->
7-
81
# Maintain Directory Structure while Globbing
92

103
If you are planning to read a few files/folders from a directory and maintain their relative path, you need to pass `{base: '.'}` as the second argument to `gulp.src()`.

‎docs/recipes/make-stream-from-buffer.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: make-stream-from-buffer
3-
title: Make Stream from Buffer
4-
hide_title: true
5-
sidebar_label: Make Stream from Buffer
6-
-->
7-
81
# Make stream from buffer (memory contents)
92

103
Sometimes you may need to start a stream with files that their contents are in a variable and not in a physical file. In other words, how to start a 'gulp' stream without using `gulp.src()`.

‎docs/recipes/minified-and-non-minified.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: minified-and-non-minified
3-
title: Outputting Minified and non-minified
4-
hide_title: true
5-
sidebar_label: Outputting Minified and non-minified
6-
-->
7-
81
# Output both a minified and non-minified version
92

103
Outputting both a minified and non-minified version of your combined JavaScript files can be achieved by using `gulp-rename` and piping to `dest` twice (once before minifying and once after minifying):

‎docs/recipes/minimal-browsersync-setup-with-gulp4.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: minimal-browsersync-setup-with-gulp4
3-
title: Minimal BrowserSync setup with Gulp 4
4-
hide_title: true
5-
sidebar_label: Minimal BrowserSync setup with Gulp 4
6-
-->
7-
81
# Minimal BrowserSync setup with Gulp 4
92

103
[BrowserSync](https://www.browsersync.io/) is a great tool to streamline

‎docs/recipes/mocha-test-runner-with-gulp.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: mocha-test-runner-with-gulp
3-
title: Mocha test-runner with Gulp
4-
hide_title: true
5-
sidebar_label: Mocha test-runner with Gulp
6-
-->
7-
81
# Mocha test-runner with gulp
92

103
### Passing shared module in all tests

‎docs/recipes/only-pass-through-changed-files.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: only-pass-through-changed-files
3-
title: Only Pass Through Changed Files
4-
hide_title: true
5-
sidebar_label: Only Pass Through Changed Files
6-
-->
7-
81
# Only pass through changed files
92

103
Files are passed through the whole pipe chain on every run by default. By using [gulp-changed](https://github.com/sindresorhus/gulp-changed) only changed files will be passed through. This can speed up consecutive runs considerably.

‎docs/recipes/pass-arguments-from-cli.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: pass-arguments-from-cli
3-
title: Pass Arguments from the CLI
4-
hide_title: true
5-
sidebar_label: Pass Arguments from the CLI
6-
-->
7-
81
# Pass arguments from the command line
92

103
```js

‎docs/recipes/rebuild-only-files-that-change.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: rebuild-only-files-that-change
3-
title: Rebuild only files that Change
4-
hide_title: true
5-
sidebar_label: Rebuild only files that Change
6-
-->
7-
81
# Rebuild only files that change
92

103
With [`gulp-watch`](https://github.com/floatdrop/gulp-watch):

‎docs/recipes/rollup-with-rollup-stream.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: rollup-with-rollup-stream
3-
title: Rollup with Rollup-Stream
4-
hide_title: true
5-
sidebar_label: Rollup with Rollup-Stream
6-
-->
7-
81
# Rollup with rollup-stream
92

103
Like Browserify, [Rollup](https://rollupjs.org/) is a bundler and thus only fits naturally into gulp if it's at the start of the pipeline. Unlike Browserify, Rollup doesn't natively produce a stream as output and needs to be wrapped before it can take this position. [rollup-stream](https://github.com/Permutatrix/rollup-stream) does this for you, producing output just like that of Browserify's `bundle()` method&mdash;as a result, most of the Browserify recipes here will also work with rollup-stream.

‎docs/recipes/run-grunt-tasks-from-gulp.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: run-grunt-tasks-from-gulp
3-
title: Run Grunt Tasks from Gulp
4-
hide_title: true
5-
sidebar_label: Run Grunt Tasks from Gulp
6-
-->
7-
81
# Run Grunt Tasks from Gulp
92

103
It is possible to run Grunt tasks / Grunt plugins from within Gulp. This can be useful during a gradual migration from Grunt to Gulp or if there's a specific plugin that you need. With the described approach no Grunt CLI and no Gruntfile is required.

‎docs/recipes/running-shell-commands.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: running-shell-commands
3-
title: Running Shell Commands
4-
hide_title: true
5-
sidebar_label: Running Shell Commands
6-
-->
7-
81
# Running Shell Commands
92

103
Sometimes it is helpful to be able to call existing command line tools from gulp.

‎docs/recipes/running-task-steps-per-folder.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: running-task-steps-per-folder
3-
title: Generating a file per Folder
4-
hide_title: true
5-
sidebar_label: Generating a file per Folder
6-
-->
7-
81
# Generating a file per folder
92

103
If you have a set of folders, and wish to perform a set of tasks on each, for instance...
@@ -53,11 +46,11 @@ gulp.task('scripts', function(done) {
5346
// write to output
5447
.pipe(gulp.dest(scriptsPath))
5548
// minify
56-
.pipe(uglify())
49+
.pipe(uglify())
5750
// rename to folder.min.js
5851
.pipe(rename(folder + '.min.js'))
5952
// write to output again
60-
.pipe(gulp.dest(scriptsPath));
53+
.pipe(gulp.dest(scriptsPath));
6154
});
6255

6356
// process all remaining files in scriptsPath root into main.js and main.min.js files

‎docs/recipes/running-tasks-in-series.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: running-tasks-in-series
3-
title: Running Tasks in Series
4-
hide_title: true
5-
sidebar_label: Running Tasks in Series
6-
-->
7-
81
# Running tasks in series
92

103
By default, gulp CLI run tasks with maximum concurrency - e.g. it launches

‎docs/recipes/server-with-livereload-and-css-injection.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: server-with-livereload-and-css-inject
3-
title: Server with Live-Reloading and CSS Injection
4-
hide_title: true
5-
sidebar_label: Server with Live-Reloading and CSS Injection
6-
-->
7-
81
# Server with live-reloading and CSS injection
92

103
With [BrowserSync](https://browsersync.io) and gulp, you can easily create a development server that is accessible to any device on the same WiFi network. BrowserSync also has live-reload built in, so there's nothing else to configure.

‎docs/recipes/sharing-streams-with-stream-factories.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: sharing-streams-with-stream-factories
3-
title: Sharing Streams with Stream Factories
4-
hide_title: true
5-
sidebar_label: Sharing Streams with Stream Factories
6-
-->
7-
81
# Sharing streams with stream factories
92

103
If you use the same plugins in multiple tasks you might find yourself getting that itch to DRY things up. This method will allow you to create factories to split out your commonly used stream chains.

‎docs/recipes/specifying-a-cwd.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: specifying-a-cwd
3-
title: Specifying a New cwd
4-
hide_title: true
5-
sidebar_label: Specifying a New cwd
6-
-->
7-
81
# Specifying a new cwd (current working directory)
92

103
This is helpful for projects using a nested directory structure, such as:

‎docs/recipes/split-tasks-across-multiple-files.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: split-tasks-across-multiple-files
3-
title: Split Tasks Across Multiple Files
4-
hide_title: true
5-
sidebar_label: Split Tasks Across Multiple Files
6-
-->
7-
81
# Split tasks across multiple files
92

103
If your `gulpfile.js` is starting to grow too large, you can split the tasks

‎docs/recipes/templating-with-swig-and-yaml-front-matter.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: templating-with-swig-and-yaml-front-matter
3-
title: Templating with Swig and YAML front-matter
4-
hide_title: true
5-
sidebar_label: Templating with Swig and YAML front-matter
6-
-->
7-
81
# Templating with Swig and YAML front-matter
92
Templating can be setup using `gulp-swig` and `gulp-front-matter`:
103

‎docs/recipes/using-external-config-file.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
<!-- front-matter
2-
id: using-external-config-file
3-
title: Using External Config File
4-
hide_title: true
5-
sidebar_label: Using External Config File
6-
-->
7-
81
# Using external config file
92

103
Beneficial because it's keeping tasks DRY and config.json can be used by another task runner, like `grunt`.

0 commit comments

Comments
 (0)