Skip to content
Marcos Caceres edited this page Mar 27, 2026 · 6 revisions

isPreview

Type: boolean Default: false

Adds a prominent red warning banner to the document indicating that this is a preview and should not be cited or referenced. Used for preview deployments (e.g. from pull request previews) to distinguish them from official versions.

Basic usage

var respecConfig = {
  isPreview: true,
};

Notes

  • Shows a large red "Preview" banner — intentionally attention-grabbing
  • Useful for PR preview deployments to avoid readers accidentally citing a draft-of-a-draft
  • Do not set in production specs

Guides

Configuration options

W3C Configuration options

Linting rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

HTML attributes

CSS Classes

Special properties

Clone this wiki locally