.rehyperc

A rehype configuration file

Type object
File match .rehyperc .rehyperc.json .rehyperc.yaml .rehyperc.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/rehyperc/latest.json
Source https://www.schemastore.org/rehyperc.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

plugins string | array[] | object

The plugins field, related to plugins in options, has either an array of plugin names (or paths) or plugin–options tuples, or an object mapping plugins to their options. Plugin options can be false, which specifies that a plugin should not be used. In all other cases, they are treated as an object, and merged by the cascade. Thus, it's possible to specify part of the options from one configuration file, and overwrite or extend it from another file.

settings object
20 nested properties
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
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"
Values: "svg" "html"
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 rules emit as warnings. Rules can also be configured with 2, to turn them into fatal errors.

Default: false
verbose boolean

Patch extra positional information. If specified, the following element:

Default: false
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:
{}
3 nested properties
useNamedReferences boolean

Prefer named character references (&) where possible.

Default: false
useShortestReferences boolean

Prefer the shortest possible reference, if that results in less bytes.

Default: false
omitOptionalSemicolons boolean

Whether to omit semicolons when possible.

Default: false
voids string[]

Tag names of elements to serialize without closing tag.

Not used in the SVG space.

upperDoctype boolean

Use a <!DOCTYPE… instead of <!doctype…. Useless except for XHTML.

Default: false
quote enum

Preferred quote to use.

Default: """
Values: """ "'"
quoteSmart boolean

Use the other quote if that results in less bytes.

Default: false
preferUnquoted boolean

Leave attributes unquoted if that results in less bytes.

Not used in the SVG space.

Default: false
omitOptionalTags boolean

Omit optional opening and closing tags. For example, in

  1. one
  2. two
, both 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 SVG space.

Default: false
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
closeSelfClosing boolean

Close self-closing nodes with an extra slash (/): instead of . See tightSelfClosing to control whether a space is used before the slash.

Not used in the SVG space.

Default: false
closeEmptyElements boolean

Close SVG elements without any content with slash (/) on the opening tag instead of an end tag: instead of . See tightSelfClosing to control whether a space is used before the slash.

Not used in the HTML space.

Default: false
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
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
tightDoctype boolean

Drop unneeded spaces in doctypes: instead of to save bytes. Note: creates invalid (but working) markup.

Default: false
bogusComments boolean

Use "bogus comments" instead of comments to save byes: <?charlie> instead of . Note: creates invalid (but working) markup.

Default: false
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
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