Skip to content

Commit

Permalink
Docs: Remove front-matter from outdated pages
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Nov 3, 2018
1 parent 96c353d commit c5af6f1
Show file tree
Hide file tree
Showing 43 changed files with 2 additions and 303 deletions.
7 changes: 0 additions & 7 deletions docs/CLI.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: cli
title: CLI
hide_title: true
sidebar_label: CLI
-->

## gulp CLI docs

### Flags
Expand Down
7 changes: 0 additions & 7 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: faq
title: FAQ
hide_title: true
sidebar_label: FAQ
-->

# FAQ

## Why gulp? Why not ____?
Expand Down
7 changes: 0 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: docs
title: Docs
hide_title: true
sidebar_label: Docs
-->

# gulp documentation

* [Getting Started](getting-started/) - Get started with gulp
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: recipes
title: Recipes
hide_title: true
sidebar_label: Recipes
-->

# Recipes

* [Automate release workflow](automate-release-workflow.md)
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/automate-release-workflow.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: automate-release-workflow
title: Automate Release Workflow
hide_title: true
sidebar_label: Automate Release Workflow
-->

# Automate release workflow

If your project follows a semantic versioning, it may be a good idea to automatize the steps needed to do a release.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/browserify-multiple-destination.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: browserify-multiple-destination
title: Browserify w/ Multiple Destinations
hide_title: true
sidebar_label: Browserify w/ Multiple Destinations
-->

# Browserify + Globs (multiple destination)

This example shows how to set up a task of bundling multiple entry points into multiple destinations using browserify.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/browserify-transforms.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: browserify-transforms
title: Browserify + Transforms
hide_title: true
sidebar_label: Browserify + Transforms
-->

# Browserify + Transforms

[Browserify](https://github.com/browserify/browserify) has become an important and indispensable
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/browserify-uglify-sourcemap.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: browserify-uglify-sourcemap
title: Browserify + Uglify2 with Sourcemaps
hide_title: true
sidebar_label: Browserify + Uglify2 with Sourcemaps
-->

# Browserify + Uglify2 with sourcemaps

[Browserify](https://github.com/browserify/browserify) has become an important and indispensable
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/browserify-with-globs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: browserify-with-globs
title: Browserify + Globs
hide_title: true
sidebar_label: Browserify + Globs
-->

# Browserify + Globs

[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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/combining-streams-to-handle-errors.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: combining-streams-to-handle-errors
title: Combining Streams to Handle Errors
hide_title: true
sidebar_label: Combining Streams to Handle Errors
-->

# Combining streams to handle errors

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/cron-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: cron-task
title: Cron Task
hide_title: true
sidebar_label: Cron Task
-->

# Run gulp task via cron job

While logged in via a user that has privileges to run `gulp`, run the following:
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/delete-files-folder.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: delete-files-folder
title: Delete files and folders
hide_title: true
sidebar_label: Delete files and folders
-->

# Delete files and folders

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/exports-as-tasks.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: export-as-tasks
title: Export as Tasks
hide_title: true
sidebar_label: Export as Tasks
-->

# Exports as Tasks

Using the ES2015 module syntax you can use your exports as tasks.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/fast-browserify-builds-with-watchify.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: fast-browserify-builds-with-watchify
title: Fast Browserify builds with Watchify
hide_title: true
sidebar_label: Fast Browserify builds with Watchify
-->

# Fast browserify builds with watchify

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/handling-the-delete-event-on-watch.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: handling-the-delete-event-on-watch
title: Handling the Delete Event on Watch
hide_title: true
sidebar_label: Handling the Delete Event on Watch
-->

# Handling the Delete Event on Watch

You can listen for `'unlink'` events to fire on the watcher returned from `gulp.watch`.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/incremental-builds-with-concatenate.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: incremental-builds-with-concatenate
title: Incremental Rebuilding
hide_title: true
sidebar_label: Incremental Rebuilding
-->

# Incremental rebuilding, including operating on full file sets

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/maintain-directory-structure-while-globbing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: maintain-directory-structure-while-globbing
title: Maintain Directory Structure while Globbing
hide_title: true
sidebar_label: Maintain Directory Structure while Globbing
-->

# Maintain Directory Structure while Globbing

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()`.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/make-stream-from-buffer.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: make-stream-from-buffer
title: Make Stream from Buffer
hide_title: true
sidebar_label: Make Stream from Buffer
-->

# Make stream from buffer (memory contents)

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()`.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/minified-and-non-minified.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: minified-and-non-minified
title: Outputting Minified and non-minified
hide_title: true
sidebar_label: Outputting Minified and non-minified
-->

# Output both a minified and non-minified version

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):
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/minimal-browsersync-setup-with-gulp4.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: minimal-browsersync-setup-with-gulp4
title: Minimal BrowserSync setup with Gulp 4
hide_title: true
sidebar_label: Minimal BrowserSync setup with Gulp 4
-->

# Minimal BrowserSync setup with Gulp 4

[BrowserSync](https://www.browsersync.io/) is a great tool to streamline
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/mocha-test-runner-with-gulp.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: mocha-test-runner-with-gulp
title: Mocha test-runner with Gulp
hide_title: true
sidebar_label: Mocha test-runner with Gulp
-->

# Mocha test-runner with gulp

### Passing shared module in all tests
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/only-pass-through-changed-files.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: only-pass-through-changed-files
title: Only Pass Through Changed Files
hide_title: true
sidebar_label: Only Pass Through Changed Files
-->

# Only pass through changed files

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/pass-arguments-from-cli.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: pass-arguments-from-cli
title: Pass Arguments from the CLI
hide_title: true
sidebar_label: Pass Arguments from the CLI
-->

# Pass arguments from the command line

```js
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/rebuild-only-files-that-change.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: rebuild-only-files-that-change
title: Rebuild only files that Change
hide_title: true
sidebar_label: Rebuild only files that Change
-->

# Rebuild only files that change

With [`gulp-watch`](https://github.com/floatdrop/gulp-watch):
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/rollup-with-rollup-stream.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: rollup-with-rollup-stream
title: Rollup with Rollup-Stream
hide_title: true
sidebar_label: Rollup with Rollup-Stream
-->

# Rollup with rollup-stream

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/run-grunt-tasks-from-gulp.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: run-grunt-tasks-from-gulp
title: Run Grunt Tasks from Gulp
hide_title: true
sidebar_label: Run Grunt Tasks from Gulp
-->

# Run Grunt Tasks from Gulp

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/running-shell-commands.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: running-shell-commands
title: Running Shell Commands
hide_title: true
sidebar_label: Running Shell Commands
-->

# Running Shell Commands

Sometimes it is helpful to be able to call existing command line tools from gulp.
Expand Down
11 changes: 2 additions & 9 deletions docs/recipes/running-task-steps-per-folder.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: running-task-steps-per-folder
title: Generating a file per Folder
hide_title: true
sidebar_label: Generating a file per Folder
-->

# Generating a file per folder

If you have a set of folders, and wish to perform a set of tasks on each, for instance...
Expand Down Expand Up @@ -53,11 +46,11 @@ gulp.task('scripts', function(done) {
// write to output
.pipe(gulp.dest(scriptsPath))
// minify
.pipe(uglify())
.pipe(uglify())
// rename to folder.min.js
.pipe(rename(folder + '.min.js'))
// write to output again
.pipe(gulp.dest(scriptsPath));
.pipe(gulp.dest(scriptsPath));
});

// process all remaining files in scriptsPath root into main.js and main.min.js files
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/running-tasks-in-series.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: running-tasks-in-series
title: Running Tasks in Series
hide_title: true
sidebar_label: Running Tasks in Series
-->

# Running tasks in series

By default, gulp CLI run tasks with maximum concurrency - e.g. it launches
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/server-with-livereload-and-css-injection.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: server-with-livereload-and-css-inject
title: Server with Live-Reloading and CSS Injection
hide_title: true
sidebar_label: Server with Live-Reloading and CSS Injection
-->

# Server with live-reloading and CSS injection

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/sharing-streams-with-stream-factories.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: sharing-streams-with-stream-factories
title: Sharing Streams with Stream Factories
hide_title: true
sidebar_label: Sharing Streams with Stream Factories
-->

# Sharing streams with stream factories

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.
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/specifying-a-cwd.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: specifying-a-cwd
title: Specifying a New cwd
hide_title: true
sidebar_label: Specifying a New cwd
-->

# Specifying a new cwd (current working directory)

This is helpful for projects using a nested directory structure, such as:
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/split-tasks-across-multiple-files.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: split-tasks-across-multiple-files
title: Split Tasks Across Multiple Files
hide_title: true
sidebar_label: Split Tasks Across Multiple Files
-->

# Split tasks across multiple files

If your `gulpfile.js` is starting to grow too large, you can split the tasks
Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/templating-with-swig-and-yaml-front-matter.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: templating-with-swig-and-yaml-front-matter
title: Templating with Swig and YAML front-matter
hide_title: true
sidebar_label: Templating with Swig and YAML front-matter
-->

# Templating with Swig and YAML front-matter
Templating can be setup using `gulp-swig` and `gulp-front-matter`:

Expand Down
7 changes: 0 additions & 7 deletions docs/recipes/using-external-config-file.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
<!-- front-matter
id: using-external-config-file
title: Using External Config File
hide_title: true
sidebar_label: Using External Config File
-->

# Using external config file

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

0 comments on commit c5af6f1

Please sign in to comment.