.remarkrc
A remark configuration file
.remarkrc.remarkrc.json.remarkrc.yaml.remarkrc.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
.remarkrc 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 | oneOf | 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 |
settings | object | — |
settings.bullet | enum | Marker to use to for bullets of items in unordered lists. default: "*"one of: "*", "+", "-" |
settings.closeAtx | boolean | Whether to add the same number of number signs (#) at the end of an ATX heading as the opening sequence. default: false |
settings.emphasis | enum | Marker to use to serialize emphasis. default: "*"one of: "*", "_" |
settings.fence | enum | Marker to use to serialize fenced code. default: "`"one of: "`", "~" |
settings.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 |
settings.incrementListMarker | boolean | Whether to increment the value of bullets of items in ordered lists. default: true |
settings.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"one of: "one", "tab", "mixed" |
settings.quote | enum | Marker to use to serialize titles. default: "\""one of: "\"", "'" |
settings.resourceLink | boolean | Whether to use resource links ([text](url)) always. The default is to use autolinks (<https://example.com>) when possible. default: false |
settings.rule | enum | Marker to use for thematic breaks. default: "*"one of: "*", "-", "_" |
settings.ruleRepetition | integer | Number of markers to use for thematic breaks. default: 3 |
settings.ruleSpaces | boolean | Whether to add spaces between markers in thematic breaks. default: false |
settings.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 |
settings.strong | enum | Marker to use to serialize strong. default: "_"one of: "*", "_" |
settings.tightDefinitions | boolean | Whether to join definitions w/o a blank line. default: false |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 17 properties, 94% carrying a description, max nesting depth 10.
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" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
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" |
minimum | JSON Schema Validation, draft 2020-12 | §6.2.4 — "minimum" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
patternProperties | JSON Schema Core, draft 2020-12 | §10.3.2.2 — "patternProperties" |
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.