Home Original page

Docs: Add front-matter to each file (#2109) · gulpjs/gulp@d693e49

45 files changed

lines changed

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: api

3+

title: API

4+

hide_title: true

5+

sidebar_label: API

6+

-->

7+
18

Note: these docs are for version v4.0.0 (aka `gulp@next`) If you're on gulp

29

v3.9.1, which is the current default `npm` release, you probably want [that

310

version's documentation](https://github.com/gulpjs/gulp/blob/v3.9.1/docs/API.md).

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: cli

3+

title: CLI

4+

hide_title: true

5+

sidebar_label: CLI

6+

-->

7+
18

## gulp CLI docs

29
310

### Flags

@@ -105,7 +112,7 @@ Output:

105112
106113

Command: `gulp --tasks-simple`

107114
108-

Output:

115+

Output:

109116

```shell

110117

one

111118

two

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: faq

3+

title: FAQ

4+

hide_title: true

5+

sidebar_label: FAQ

6+

-->

7+
18

# FAQ

29
310

## Why gulp? Why not ____?

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: docs

3+

title: Docs

4+

hide_title: true

5+

sidebar_label: Docs

6+

-->

7+
18

# gulp documentation

29
310

* [Getting Started](getting-started.md) - Get started with gulp

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: getting-started

3+

title: Getting Started

4+

hide_title: true

5+

sidebar_label: Getting Started

6+

-->

7+
18

# Getting Started

29
310

*If you've previously installed gulp globally, run `npm rm --global gulp` before following these instructions.* For more information, read this [Sip](https://medium.com/gulpjs/gulp-sips-command-line-interface-e53411d4467).

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: recipes

3+

title: Recipes

4+

hide_title: true

5+

sidebar_label: Recipes

6+

-->

7+
18

# Recipes

29
310

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

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

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+
18

# Automate release workflow

29
310

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

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

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+
18

# Browserify + Globs (multiple destination)

29
310

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

Original file line numberDiff line numberDiff line change

@@ -1,3 +1,10 @@

1+

<!-- front-matter

2+

id: browserify-transforms

3+

title: Browserify + Transforms

4+

hide_title: true

5+

sidebar_label: Browserify + Transforms

6+

-->

7+
18

# Browserify + Transforms

29
310

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

Original file line numberDiff line numberDiff line change

@@ -1,10 +1,17 @@

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+
18

# Browserify + Uglify2 with sourcemaps

29
310

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

411

tool but requires being wrapped before working well with gulp. Below is a simple recipe for using

512

Browserify with full sourcemaps that resolve to the original individual files.

613
7-

See also: the [Combining Streams to Handle Errors](https://github.com/gulpjs/gulp/blob/master/docs/recipes/combining-streams-to-handle-errors.md) recipe for handling errors with browserify or uglify in your stream.

14+

See also: the [Combining Streams to Handle Errors](https://github.com/gulpjs/gulp/blob/master/docs/recipes/combining-streams-to-handle-errors.md) recipe for handling errors with browserify or uglify in your stream.

815
916

A simple `gulpfile.js` file for Browserify + Uglify2 with sourcemaps:

1017