Skip to content

Commit 6a8fd8f

Browse files
phatedphated
committed
Docs: Add some more cleanup for Docusaurus
1 parent df7cdcb commit 6a8fd8f

14 files changed

+16
-16
lines changed

Diff for: ‎docs/api/concepts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-concepts
2+
id: concepts
33
title: API Concepts
44
hide_title: true
55
sidebar_label: Concepts

Diff for: ‎docs/api/dest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-dest
2+
id: dest
33
title: dest()
44
hide_title: true
55
sidebar_label: dest()

Diff for: ‎docs/api/last-run.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-lastrun
2+
id: lastrun
33
title: lastRun()
44
hide_title: true
55
sidebar_label: lastRun()

Diff for: ‎docs/api/parallel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-parallel
2+
id: parallel
33
title: parallel()
44
hide_title: true
55
sidebar_label: parallel()

Diff for: ‎docs/api/registry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-registry
2+
id: registry
33
title: registry()
44
hide_title: true
55
sidebar_label: registry()

Diff for: ‎docs/api/series.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-series
2+
id: series
33
title: series()
44
hide_title: true
55
sidebar_label: series()

Diff for: ‎docs/api/src.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-src
2+
id: src
33
title: src()
44
hide_title: true
55
sidebar_label: src()

Diff for: ‎docs/api/symlink.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-symlink
2+
id: symlink
33
title: symlink()
44
hide_title: true
55
sidebar_label: symlink()

Diff for: ‎docs/api/task.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-task
2+
id: task
33
title: task()
44
hide_title: true
55
sidebar_label: task()

Diff for: ‎docs/api/tree.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-tree
2+
id: tree
33
title: tree()
44
hide_title: true
55
sidebar_label: tree()

Diff for: ‎docs/api/vinyl-iscustomprop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-vinyl-iscustomprop
2+
id: vinyl-iscustomprop
33
title: Vinyl.isCustomProp()
44
hide_title: true
55
sidebar_label: Vinyl.isCustomProp()

Diff for: ‎docs/api/vinyl-isvinyl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-vinyl-isvinyl
2+
id: vinyl-isvinyl
33
title: Vinyl.isVinyl()
44
hide_title: true
55
sidebar_label: Vinyl.isVinyl()

Diff for: ‎docs/api/vinyl.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-vinyl
2+
id: vinyl
33
title: Vinyl
44
hide_title: true
55
sidebar_label: Vinyl
@@ -93,12 +93,12 @@ All internally managed paths - any instance property except `contents` and `stat
9393

9494
| property | type | description | throws |
9595
|:-----------:|:------:|----------------|----------|
96-
| contents | ReadableStream <br> Buffer <br> `null` | Gets and sets the contents of the virtual file. If set to a ReadableStream, it is wrapped in a [cloneable-readable][cloneable-readable-docs] stream. | If set to any value other than a ReadableStream, a Buffer, or `null`. |
96+
| contents | ReadableStream <br> Buffer <br> `null` | Gets and sets the contents of the virtual file. If set to a ReadableStream, it is wrapped in a [cloneable-readable][cloneable-readable-external] stream. | If set to any value other than a ReadableStream, a Buffer, or `null`. |
9797
| stat | object | Gets and sets an instance of [`fs.Stats`][fs-stats-concepts]. Used when determining if a Vinyl object represents a directory or symbolic link. | |
9898
| cwd | string | Gets and sets the current working directory. Used for deriving relative paths. | If set to an empty string or any non-string value. |
9999
| base | string | Gets and sets the base directory. Used to calculate the `relative` instance property. On a Vinyl object generated by `src()` will be set to the [glob base][glob-base-concepts]. If set to `null` or `undefined`, falls back to the value of the `cwd` instance property. | If set to an empty string or any non-string value (except `null` or `undefined`). |
100100
| path | string | Gets and sets the full, absolute file path. Setting to a value different from the current `path` appends the new path to the `history` instance property. | If set to any non-string value. |
101-
| history | array | Array of all `path` values the Vinyl object has been assigned. The first element (`history[0]`) is the original path and the last element (`history[file.history.length - 1]`) is the current path. This property and its elements should be treated as read-only and only altered indirectly by setting the `path` instance property. | |
101+
| history | array | Array of all `path` values the Vinyl object has been assigned. The first element is the original path and the last element is the current path. This property and its elements should be treated as read-only and only altered indirectly by setting the `path` instance property. | |
102102
| relative | string | Gets the relative path segment between the `base` and the `path` instance properties. | If set to any value. If accessed when `path` is not available. |
103103
| dirname | string | Gets and sets the directory of the `path` instance property. | If accessed when `path` is not available. |
104104
| stem | string | Gets and sets the stem (filename without extension) of the `path` instance property. | If accessed when `path` is not available. |

Diff for: ‎docs/api/watch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- front-matter
2-
id: api-watch
2+
id: watch
33
title: watch()
44
hide_title: true
55
sidebar_label: watch()

0 commit comments

Comments
 (0)