Docs: Remove spaces around <br>

gulpjs · Oct 24, 2018 · c960c1d · c960c1d
1 parent eb493a2
commit c960c1d
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 76 deletions.
diff --git a/docs/api/dest.md b/docs/api/dest.md
@@ -32,7 +32,7 @@ dest(directory, [options])
 
 | parameter | type | note |
 |:--------------:|:-----:|--------|
-| directory <br> **(required)** | string <br> function | The path of the output directory where files will be written. If a function is used, the function will be called with each Vinyl object and must return a string directory path. |
+| directory<br>**(required)** | string<br>function | The path of the output directory where files will be written. If a function is used, the function will be called with each Vinyl object and must return a string directory path. |
 | options | object | Detailed in [Options][options-section] below. |
 
 ### Returns
@@ -60,14 +60,14 @@ When `directory` is a function that returns an empty string or `undefined`, emit
 
 | name | type | default | note |
 |:-------:|:------:|-----------|-------|
-| cwd | string <br> function | `process.cwd()` | The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `directory` with `path.join()`. |
-| mode | number <br> function | `stat.mode` of the Vinyl object | The mode used when creating files. If not set and `stat.mode` is missing, the process' mode will be used instead. |
-| dirMode | number <br> function | | The mode used when creating directories. If not set, the process' mode will be used. |
-| overwrite | boolean <br> function | true | When true, overwrites existing files with the same path. |
-| append | boolean <br> function | false | If true, adds contents to the end of the file, instead of replacing existing contents. |
-| sourcemaps | boolean <br> string <br> function | false | If true, writes inline sourcemaps to the output file. Specifying a `string` path will write external [sourcemaps][sourcemaps-section] at the given path. |
-| relativeSymlinks | boolean <br> function | false | When false, any symbolic links created will be absolute. <br> **Note**: Ignored if a junction is being created, as they must be absolute. |
-| useJunctions | boolean <br> function | true | This option is only relevant on Windows and ignored elsewhere. When true, creates directory symbolic link as a junction. Detailed in [Symbolic links on Windows][symbolic-links-section] below. |
+| cwd | string<br>function | `process.cwd()` | The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `directory` with `path.join()`. |
+| mode | number<br>function | `stat.mode` of the Vinyl object | The mode used when creating files. If not set and `stat.mode` is missing, the process' mode will be used instead. |
+| dirMode | number<br>function | | The mode used when creating directories. If not set, the process' mode will be used. |
+| overwrite | boolean<br>function | true | When true, overwrites existing files with the same path. |
+| append | boolean<br>function | false | If true, adds contents to the end of the file, instead of replacing existing contents. |
+| sourcemaps | boolean<br>string<br>function | false | If true, writes inline sourcemaps to the output file. Specifying a `string` path will write external [sourcemaps][sourcemaps-section] at the given path. |
+| relativeSymlinks | boolean<br>function | false | When false, any symbolic links created will be absolute.<br>**Note**: Ignored if a junction is being created, as they must be absolute. |
+| useJunctions | boolean<br>function | true | This option is only relevant on Windows and ignored elsewhere. When true, creates directory symbolic link as a junction. Detailed in [Symbolic links on Windows][symbolic-links-section] below. |
 
 ## Metadata updates
 

diff --git a/docs/api/last-run.md b/docs/api/last-run.md
@@ -41,7 +41,7 @@ lastRun(task, [precision])
 
 | parameter | type | note |
 |:--------------:|:------:|-------|
-| task <br> **(required)** | function <br> string | The task function or the string alias of a registered task. |
+| task<br>**(required)** | function<br>string | The task function or the string alias of a registered task. |
 | precision | number | Default: `1000` on Node v0.10, `0` on Node v0.12+. Detailed in [Timestamp precision][timestamp-precision-section] section below. |
 
 ### Returns

diff --git a/docs/api/parallel.md b/docs/api/parallel.md
@@ -37,7 +37,7 @@ parallel(...tasks)
 
 | parameter | type | note |
 |:--------------:|:------:|-------|
-| tasks <br> **(required)** | function <br> string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
+| tasks<br>**(required)** | function<br>string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
 
 ### Returns
 

diff --git a/docs/api/series.md b/docs/api/series.md
@@ -37,7 +37,7 @@ series(...tasks)
 
 | parameter | type | note |
 |:--------------:|:------:|-------|
-| tasks  <br> **(required)** | function <br> string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
+| tasks<br>**(required)** | function<br>string | Any number of task functions can be passed as individual arguments. Strings can be used if you've registered tasks previously, but this is not recommended. |
 
 ### Returns
 

diff --git a/docs/api/src.md b/docs/api/src.md
@@ -35,7 +35,7 @@ src(globs, [options])
 
 | parameter | type | note |
 |:--------------:|:------:|-------|
-| globs | string <br> array | [Globs][globs-concepts] to watch on the file system. |
+| globs | string<br>array | [Globs][globs-concepts] to watch on the file system. |
 | options | object | Detailed in [Options][options-section] below. |
 
 ### Returns
@@ -55,39 +55,39 @@ When an invalid glob is given in `globs`, throws an error with the message, "Inv
 
 | name | type | default | note |
 |:--------:|:------:|------------|--------|
-| buffer | boolean <br> function | true | When true, file contents are buffered into memory. If false, the Vinyl object's `contents` property will be a paused stream. It may not be possible to buffer the contents of large files. <br> **Note:** Plugins may not implement support for streaming contents. |
-| read | boolean <br> function | true | If false, files will be not be read and their Vinyl objects won't be writable to disk via `.dest()`. |
-| since | date <br> timestamp <br> function | | When set, only creates Vinyl objects for files modified since the specified time. |
-| removeBOM | boolean <br> function | true | When true, removes the BOM from UTF-8 encoded files. If false, ignores a BOM. |
-| sourcemaps | boolean <br> function | false | If true, enables [sourcemaps][sourcemaps-section] support on Vinyl objects created. Loads inline sourcemaps and resolves external sourcemap links. |
-| resolveSymlinks | boolean <br> function | true | When true, recursively resolves symbolic links to their targets. If false, preserves the symbolic links and sets the Vinyl object's `symlink` property to the original file's path. |
-| cwd | string | `process.cwd()` | The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `globs` with `path.join()`. <br> _This option is passed directly to [glob-stream][glob-stream-external]._ |
-| base | string | | Explicitly set the `base` property on created Vinyl objects. Detailed in [API Concepts][glob-base-concepts]. <br> _This option is passed directly to [glob-stream][glob-stream-external]._ |
-| cwdbase | boolean | false | If true, `cwd` and `base` options should be aligned. <br> _This option is passed directly to [glob-stream][glob-stream-external]._ |
-| root | string | | The root path that `globs` are resolved against. <br> _This option is passed directly to [glob-stream][glob-stream-external]._ |
-| allowEmpty | boolean | false | When false, `globs` which can only match one file (such as `foo/bar.js`) causes an error to be thrown if they don't find a match. If true, suppresses glob failures. <br> _This option is passed directly to [glob-stream][glob-stream-external]._ |
-| uniqueBy | string <br> function | `'path'` | Remove duplicates from the stream by comparing the string property name or the result of the function. <br> **Note:** When using a function, the function receives the streamed data (objects containing `cwd`, `base`, `path` properties). |
-| dot | boolean | false | If true, compare globs against dot files, like `.gitignore`. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| silent | boolean | true | When true, suppresses warnings from printing on `stderr`. <br> **Note:** This option is passed directly to [node-glob][node-glob-external] but defaulted to `true` instead of `false`. |
-| mark | boolean | false | If true, a `/` character will be appended to directory matches. Generally not needed because paths are normalized within the pipeline. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| nosort | boolean | false | If true, disables sorting the glob results. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| stat | boolean | false | If true, `fs.stat()` is called on all results. This adds extra overhead and generally should not be used. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| strict | boolean | false | If true, an error will be thrown if an unexpected problem is encountered while attempting to read a directory. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| nounique | boolean | false | When false, prevents duplicate files in the result set. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| debug | boolean | false | If true, debugging information will be logged to the command line. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| nobrace | boolean | false | If true, avoids expanding brace sets - e.g. `{a,b}` or `{1..3}`. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| noglobstar | boolean | false | If true, treats double-star glob character as single-star glob character. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| noext | boolean | false | If true, avoids matching [extglob][extglob-docs] patterns - e.g. `+(ab)`. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| nocase | boolean | false | If true, performs a case-insensitive match. <br> **Note:** On case-insensitive file systems, non-magic patterns will match by default. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| matchBase | boolean | false | If true and globs don't contain any `/` characters, traverses all directories and matches that glob - e.g. `*.js` would be treated as equivalent to `**/*.js`. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| nodir | boolean | false | If true, only matches files, not directories. <br> **Note:** To match only directories, end your glob with a `/`. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| ignore | string <br> array | | Globs to exclude from matches. This option is combined with negated `globs`. <br> **Note:** These globs are always matched against dot files, regardless of any other settings. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| follow | boolean | false | If true, symlinked directories will be traversed when expanding `**` globs. <br> **Note:** This can cause problems with cyclical links. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| realpath | boolean | false | If true, `fs.realpath()` is called on all results. This may result in dangling links. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| cache | object | | A previously generated cache object - avoids some file system calls. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| statCache | object | | A previously generated cache of `fs.Stat` results - avoids some file system calls. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| symlinks | object | | A previously generated cache of symbolic links - avoids some file system calls. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
-| nocomment | boolean | false | When false, treat a `#` character at the start of a glob as a comment. <br> _This option is passed directly to [node-glob][node-glob-external]._ |
+| buffer | boolean<br>function | true | When true, file contents are buffered into memory. If false, the Vinyl object's `contents` property will be a paused stream. It may not be possible to buffer the contents of large files.<br>**Note:** Plugins may not implement support for streaming contents. |
+| read | boolean<br>function | true | If false, files will be not be read and their Vinyl objects won't be writable to disk via `.dest()`. |
+| since | date<br>timestamp<br>function | | When set, only creates Vinyl objects for files modified since the specified time. |
+| removeBOM | boolean<br>function | true | When true, removes the BOM from UTF-8 encoded files. If false, ignores a BOM. |
+| sourcemaps | boolean<br>function | false | If true, enables [sourcemaps][sourcemaps-section] support on Vinyl objects created. Loads inline sourcemaps and resolves external sourcemap links. |
+| resolveSymlinks | boolean<br>function | true | When true, recursively resolves symbolic links to their targets. If false, preserves the symbolic links and sets the Vinyl object's `symlink` property to the original file's path. |
+| cwd | string | `process.cwd()` | The directory that will be combined with any relative path to form an absolute path. Is ignored for absolute paths. Use to avoid combining `globs` with `path.join()`.<br>_This option is passed directly to [glob-stream][glob-stream-external]._ |
+| base | string | | Explicitly set the `base` property on created Vinyl objects. Detailed in [API Concepts][glob-base-concepts].<br>_This option is passed directly to [glob-stream][glob-stream-external]._ |
+| cwdbase | boolean | false | If true, `cwd` and `base` options should be aligned.<br>_This option is passed directly to [glob-stream][glob-stream-external]._ |
+| root | string | | The root path that `globs` are resolved against.<br>_This option is passed directly to [glob-stream][glob-stream-external]._ |
+| allowEmpty | boolean | false | When false, `globs` which can only match one file (such as `foo/bar.js`) causes an error to be thrown if they don't find a match. If true, suppresses glob failures.<br>_This option is passed directly to [glob-stream][glob-stream-external]._ |
+| uniqueBy | string<br>function | `'path'` | Remove duplicates from the stream by comparing the string property name or the result of the function.<br>**Note:** When using a function, the function receives the streamed data (objects containing `cwd`, `base`, `path` properties). |
+| dot | boolean | false | If true, compare globs against dot files, like `.gitignore`.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| silent | boolean | true | When true, suppresses warnings from printing on `stderr`.<br>**Note:** This option is passed directly to [node-glob][node-glob-external] but defaulted to `true` instead of `false`. |
+| mark | boolean | false | If true, a `/` character will be appended to directory matches. Generally not needed because paths are normalized within the pipeline.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| nosort | boolean | false | If true, disables sorting the glob results.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| stat | boolean | false | If true, `fs.stat()` is called on all results. This adds extra overhead and generally should not be used.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| strict | boolean | false | If true, an error will be thrown if an unexpected problem is encountered while attempting to read a directory.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| nounique | boolean | false | When false, prevents duplicate files in the result set.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| debug | boolean | false | If true, debugging information will be logged to the command line.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| nobrace | boolean | false | If true, avoids expanding brace sets - e.g. `{a,b}` or `{1..3}`.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| noglobstar | boolean | false | If true, treats double-star glob character as single-star glob character.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| noext | boolean | false | If true, avoids matching [extglob][extglob-docs] patterns - e.g. `+(ab)`.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| nocase | boolean | false | If true, performs a case-insensitive match.<br>**Note:** On case-insensitive file systems, non-magic patterns will match by default.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| matchBase | boolean | false | If true and globs don't contain any `/` characters, traverses all directories and matches that glob - e.g. `*.js` would be treated as equivalent to `**/*.js`.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| nodir | boolean | false | If true, only matches files, not directories.<br>**Note:** To match only directories, end your glob with a `/`.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| ignore | string<br>array | | Globs to exclude from matches. This option is combined with negated `globs`.<br>**Note:** These globs are always matched against dot files, regardless of any other settings.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| follow | boolean | false | If true, symlinked directories will be traversed when expanding `**` globs.<br>**Note:** This can cause problems with cyclical links.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| realpath | boolean | false | If true, `fs.realpath()` is called on all results. This may result in dangling links.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| cache | object | | A previously generated cache object - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| statCache | object | | A previously generated cache of `fs.Stat` results - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| symlinks | object | | A previously generated cache of symbolic links - avoids some file system calls.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
+| nocomment | boolean | false | When false, treat a `#` character at the start of a glob as a comment.<br>_This option is passed directly to [node-glob][node-glob-external]._ |
 
 ## Sourcemaps