Skip to content

Commit

Permalink
Docs: Remove temporary workaround for facebook/docusaurus#257
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Oct 19, 2018
1 parent 3d051d8 commit 5c07954
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started/3-creating-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Creating Tasks

# Creating Tasks

Each gulp task is an asynchronous JavaScript function - a function that accepts an error-first callback or returns a stream, promise, event emitter, child process, or observable ([more on that later](4-async-completion.md)). Due to some platform limitations, synchronous tasks aren't supported, though there is a pretty nifty [alternative](4-async-completion.md#using-asyncawait).
Each gulp task is an asynchronous JavaScript function - a function that accepts an error-first callback or returns a stream, promise, event emitter, child process, or observable ([more on that later][async-completion-docs]). Due to some platform limitations, synchronous tasks aren't supported, though there is a pretty nifty [alternative][using-async-await-docs].

## Exporting

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/5-working-with-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ sidebar_label: Working with Files

The `src()` and `dest()` methods are exposed by gulp to interact with files on your computer.

`src()` is given a [glob](6-explaining-globs.md) to read from the file system and produces a [Node stream][node-streams-docs]. It locates all matching files and reads them into memory to pass through the stream.
`src()` is given a [glob][explaining-globs-docs] to read from the file system and produces a [Node stream][node-streams-docs]. It locates all matching files and reads them into memory to pass through the stream.

The stream produced by `src()` should be returned from a task to signal async completion, as mentioned in [Creating Tasks](3-creating-tasks.md).
The stream produced by `src()` should be returned from a task to signal async completion, as mentioned in [Creating Tasks][creating-tasks-docs].

```js
const { src, dest } = require('gulp');
Expand Down Expand Up @@ -41,7 +41,7 @@ Most often plugins will be placed between `src()` and `dest()` using the `.pipe(

## Adding files to the stream

`src()` can also be placed in the middle of a pipeline to add files to the stream based on the given globs. The additional files will only be available to transformations later in the stream. If [globs overlap](6-explaining-globs.md#overlapping-globs), the files will be added again.
`src()` can also be placed in the middle of a pipeline to add files to the stream based on the given globs. The additional files will only be available to transformations later in the stream. If [globs overlap][overlapping-globs-docs], the files will be added again.

This can be useful for transpiling some files before adding plain JavaScript files to the pipeline and uglifying everything.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/8-watching-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Watching Files

# Watching Files

The `watch()` API connects [globs](6-explaining-globs.md) to [tasks](3-creating-tasks.md) using a file system watcher. It watches for changes to files that match the globs and executes the task when a change occurs. If the task doesn't signal [Async Completion](4-async-completion.md), it will never be run a second time.
The `watch()` API connects [globs][globs-docs] to [tasks][creating-tasks-docs] using a file system watcher. It watches for changes to files that match the globs and executes the task when a change occurs. If the task doesn't signal [Async Completion][async-completion-doc], it will never be run a second time.

This API provides built-in delay and queueing based on most-common-use defaults.

Expand Down

0 comments on commit 5c07954

Please sign in to comment.