Skip to content

Commit

Permalink
docs(options/*_BUILD_OVERRIDE): link to ReSpec, Bikeshed docs (#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoscaceres authored May 28, 2021
1 parent b1be245 commit 8100103
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Define exit behaviour on build errors or warnings.

Override Bikeshed metadata or ReSpec config for the GitHub Pages deployment.

Note that, you need to use [Bikeshed-specific metadata](https://tabatkins.github.io/bikeshed/) (e.g. `status`) when using Bikeshed, and [ReSpec-specific config](https://respec.org/docs/#configuration-options) (e.g. `specStatus`) when using ReSpec.

**Possible values:** A string or [YAML Literal Block Scalar](https://stackoverflow.com/a/15365296) (multiline string) representing the override config/metadata as key-value pairs. That's mouthful, lets clarify using an example:

```yaml
Expand All @@ -71,8 +73,6 @@ Override Bikeshed metadata or ReSpec config for the GitHub Pages deployment.

**Default:** None.

Note that, you need to use Bikeshed-specific metadata (e.g. `status`) when using Bikeshed, and ReSpec-specific config (e.g. `specStatus`) when using ReSpec.

## `W3C_BUILD_OVERRIDE`

Override Bikeshed metadata or ReSpec config for the W3C Deployment and validators.
Expand Down

0 comments on commit 8100103

Please sign in to comment.