.remarkrc

A remark configuration file

Type object
File match .remarkrc .remarkrc.json .remarkrc.yaml .remarkrc.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/remarkrc/latest.json
Source https://www.schemastore.org/remarkrc.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
15 nested properties
bullet enum

Marker to use to for bullets of items in unordered lists.

Default: "*"
Values: "*" "+" "-"
closeAtx boolean

Whether to add the same number of number signs (#) at the end of an ATX heading as the opening sequence.

Default: false
emphasis enum

Marker to use to serialize emphasis.

Default: "*"
Values: "*" "_"
fence enum

Marker to use to serialize fenced code.

Default: "`"
Values: "`" "~"
fences boolean

Whether to use fenced code always. The default is to fenced code if there is a language defined, if the code is empty, or if it starts or ends in empty lines

Default: false
incrementListMarker boolean

Whether to increment the value of bullets of items in ordered lists.

Default: true
listItemIndent enum

Whether to indent the content of list items with the size of the bullet plus one space (when 'one') or a tab stop ('tab'), or depending on the item and its parent list ('mixed', uses 'one' if the item and list are tight and 'tab' otherwise)

Default: "tab"
Values: "one" "tab" "mixed"
quote enum

Marker to use to serialize titles.

Default: """
Values: """ "'"
resourceLink boolean

Whether to use resource links (text) always. The default is to use autolinks (https://example.com) when possible.

Default: false
rule enum

Marker to use for thematic breaks.

Default: "*"
Values: "*" "-" "_"
ruleRepetition integer

Number of markers to use for thematic breaks.

Default: 3
min=3
ruleSpaces boolean

Whether to add spaces between markers in thematic breaks.

Default: false
setext boolean

Whether to use setext headings when possible. Setext headings are not possible for headings with a rank more than 2 or when they're empty.

Default: false
strong enum

Marker to use to serialize strong.

Default: "_"
Values: "*" "_"
tightDefinitions boolean

Whether to join definitions w/o a blank line.

Default: false