Skip to content

Commit

Permalink
Docs: Add some more cleanup for Docusaurus
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Oct 19, 2018
1 parent df7cdcb commit 6a8fd8f
Show file tree
Hide file tree
Showing 14 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/api/concepts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-concepts
id: concepts
title: API Concepts
hide_title: true
sidebar_label: Concepts
Expand Down
2 changes: 1 addition & 1 deletion docs/api/dest.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-dest
id: dest
title: dest()
hide_title: true
sidebar_label: dest()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/last-run.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-lastrun
id: lastrun
title: lastRun()
hide_title: true
sidebar_label: lastRun()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/parallel.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-parallel
id: parallel
title: parallel()
hide_title: true
sidebar_label: parallel()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/registry.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-registry
id: registry
title: registry()
hide_title: true
sidebar_label: registry()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/series.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-series
id: series
title: series()
hide_title: true
sidebar_label: series()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/src.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-src
id: src
title: src()
hide_title: true
sidebar_label: src()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/symlink.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-symlink
id: symlink
title: symlink()
hide_title: true
sidebar_label: symlink()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/task.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-task
id: task
title: task()
hide_title: true
sidebar_label: task()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/tree.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-tree
id: tree
title: tree()
hide_title: true
sidebar_label: tree()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/vinyl-iscustomprop.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-vinyl-iscustomprop
id: vinyl-iscustomprop
title: Vinyl.isCustomProp()
hide_title: true
sidebar_label: Vinyl.isCustomProp()
Expand Down
2 changes: 1 addition & 1 deletion docs/api/vinyl-isvinyl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-vinyl-isvinyl
id: vinyl-isvinyl
title: Vinyl.isVinyl()
hide_title: true
sidebar_label: Vinyl.isVinyl()
Expand Down
6 changes: 3 additions & 3 deletions docs/api/vinyl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-vinyl
id: vinyl
title: Vinyl
hide_title: true
sidebar_label: Vinyl
Expand Down Expand Up @@ -93,12 +93,12 @@ All internally managed paths - any instance property except `contents` and `stat

| property | type | description | throws |
|:-----------:|:------:|----------------|----------|
| 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`. |
| 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`. |
| 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. | |
| 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. |
| 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`). |
| 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. |
| 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. | |
| 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. | |
| 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. |
| dirname | string | Gets and sets the directory of the `path` instance property. | If accessed when `path` is not available. |
| stem | string | Gets and sets the stem (filename without extension) of the `path` instance property. | If accessed when `path` is not available. |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/watch.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- front-matter
id: api-watch
id: watch
title: watch()
hide_title: true
sidebar_label: watch()
Expand Down

0 comments on commit 6a8fd8f

Please sign in to comment.