.rehyperc
A rehype configuration file
.rehyperc.rehyperc.json.rehyperc.yaml.rehyperc.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
.rehyperc and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
plugins | any | — |
settings | object | — |
settings.fragment | boolean | Specify whether to parse a fragment, instead of a complete document. In document mode, unopened html, head, and body elements are opened in just the right places. default: false |
settings.space | enum | Which space the document is in. If an svg element is found in the HTML space, parse automatically switches to the SVG space when entering the element, and switches back when exiting. Note: make sure to set fragment: true if space: 'svg'. default: "html"one of: "svg", "html" |
settings.emitParseErrors | boolean | Emit parse errors while parsing on the vfile. Setting this to true starts emitting HTML parse errors. Specific rules can be turned off by setting them to false (or 0). The default, when emitParseErrors: true, is true (or 1), and means that default: false |
settings.verbose | boolean | Patch extra positional information. If specified, the following element: default: false |
settings.entities | object | Configuration for stringify-entities. Do not use escapeOnly, attribute, or subset (toHtml already passes those, so they won't work). However, useNamedReferences, useShortestReferences, and omitOptionalSemicolons are all fine. default: {} |
settings.entities.useNamedReferences | boolean | Prefer named character references (&) where possible. default: false |
settings.entities.useShortestReferences | boolean | Prefer the shortest possible reference, if that results in less bytes. default: false |
settings.entities.omitOptionalSemicolons | boolean | Whether to omit semicolons when possible. default: false |
settings.voids | array<string> | Tag names of elements to serialize without closing tag. Not used in the SVG space. |
settings.upperDoctype | boolean | Use a <!DOCTYPE… instead of <!doctype…. Useless except for XHTML. default: false |
settings.quote | enum | Preferred quote to use. default: "\""one of: "\"", "'" |
settings.quoteSmart | boolean | Use the other quote if that results in less bytes. default: false |
settings.preferUnquoted | boolean | Leave attributes unquoted if that results in less bytes. Not used in the SVG space. default: false |
settings.omitOptionalTags | boolean | Omit optional opening and closing tags. For example, in <ol><li>one</li><li>two</li></ol>, both </li> closing tags can be omitted. The first because it's followed by another li, the last because it's followed by nothing. Not used in the default: false |
settings.collapseEmptyAttributes | boolean | Collapse empty attributes: get class instead of class="". Note: boolean attributes, such as hidden, are always collapsed. Not used in the SVG space. default: false |
settings.closeSelfClosing | boolean | Close self-closing nodes with an extra slash (/): <img /> instead of <img>. See tightSelfClosing to control whether a space is used before the slash. Not used in the SVG space. default: false |
settings.closeEmptyElements | boolean | Close SVG elements without any content with slash (/) on the opening tag instead of an end tag: <circle /> instead of <circle></circle>. See tightSelfClosing to control whether a space is used before the slash. Not used in the HTML space. default: false |
settings.tightCommaSeparatedLists | boolean | Join known comma-separated attribute values with just a comma (,), instead of padding them on the right as well (,·, where · represents a space). default: false |
settings.tightAttributes | boolean | Join attributes together, without whitespace, if possible: get class="a b"title="c d" instead of class="a b" title="c d" to save bytes. Note: creates invalid (but working) markup. Not used in the SVG space. default: false |
settings.tightDoctype | boolean | Drop unneeded spaces in doctypes: <!doctypehtml> instead of <!doctype html> to save bytes. Note: creates invalid (but working) markup. default: false |
settings.bogusComments | boolean | Use "bogus comments" instead of comments to save byes: <?charlie> instead of <!--charlie-->. Note: creates invalid (but working) markup. default: false |
settings.allowParseErrors | boolean | Do not encode characters which cause parse errors (even though they work), to save bytes. Note: creates invalid (but working) markup. Not used in the SVG space. default: false |
settings.allowDangerousHtml | boolean | Allow raw nodes and insert them as raw HTML. When falsey, encodes raw nodes. Note: Only set this if you completely trust the content. default: false |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 25 properties, 92% carrying a description, max nesting depth 7.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.