From 5c079544db5ac12c8efcb6560e1581f2339aadd9 Mon Sep 17 00:00:00 2001 From: Blaine Bublitz Date: Thu, 18 Oct 2018 17:02:03 -0700 Subject: [PATCH] Docs: Remove temporary workaround for facebook/Docusaurus#257 --- docs/getting-started/3-creating-tasks.md | 2 +- docs/getting-started/5-working-with-files.md | 6 +++--- docs/getting-started/8-watching-files.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-started/3-creating-tasks.md b/docs/getting-started/3-creating-tasks.md index 48ea9ed64..5d784a5bd 100644 --- a/docs/getting-started/3-creating-tasks.md +++ b/docs/getting-started/3-creating-tasks.md @@ -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 diff --git a/docs/getting-started/5-working-with-files.md b/docs/getting-started/5-working-with-files.md index 2e87d2e5b..1f2e7af71 100644 --- a/docs/getting-started/5-working-with-files.md +++ b/docs/getting-started/5-working-with-files.md @@ -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'); @@ -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. diff --git a/docs/getting-started/8-watching-files.md b/docs/getting-started/8-watching-files.md index 82a16b330..910fdbd41 100644 --- a/docs/getting-started/8-watching-files.md +++ b/docs/getting-started/8-watching-files.md @@ -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.