{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"recheck","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," block configures the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/recheck"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}]}," command."," ","It adjusts the rules that the Recheck presets provide, and it sets file excludes and Markdoc parsing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The block does not accept ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]},"."," ","Add Recheck presets, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/markdown"]},", to the root ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"."," ","The block merges on top of the presets that the same file lists in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]},"."," ","Presets and shared config files merge in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]}," order, so a preset listed after a shared file overrides the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," block of that file."," ","An unknown preset name, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/nope"]},", is a configuration error."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":2},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["rules"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#rules-object"},"children":["Rules object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rule names mapped to a severity or to a ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#rule-object"},"children":["rule object"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["excludes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["File globs that every rule in this block skips."," ","Recheck adds this list to each rule's own ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludes"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["markdoc"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean or ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#markdoc-object"},"children":["Markdoc object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Turn on Markdoc-aware parsing."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," is the same as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ schema: realm }"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rules-object","__idx":3},"children":["Rules object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each key is a rule name."," ","Each value is a severity string (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},") or a ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#rule-object"},"children":["rule object"]},"."," ","Use a severity string to change the severity of a preset rule or to turn it off."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rule-object","__idx":4},"children":["Rule object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["severity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED"]},"."," ","One of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["message"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The message that the rule reports."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED"]}," for a scope rule, which uses an assertion such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pattern"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metric"]},"."," ","A token rule, which uses an assertion such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line-length"]},", takes its default message when the entry has none."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["assertions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED"]},"."," ","The checks that the rule runs."," ","Each assertion type has its own options."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fix"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Let ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--fix"]}," apply this rule's fix."," ","Only some assertion types offer a fix."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Labels for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--tags"]}," option."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A note about the purpose of the rule."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["link"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL with more detail about the rule."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["scope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string or [string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Where the rule runs: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["all"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sentence"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paragraph"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["raw"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["appliesTo"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["File globs that the rule runs on."," ","Default value is every Markdown file."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["excludes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["File globs that the rule skips."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["exceptions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#exceptions-object"},"children":["Exceptions object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Files and lines that the rule does not check."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"exceptions-object","__idx":5},"children":["Exceptions object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["File globs that the rule skips."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lines"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Line patterns that the rule skips."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"markdoc-object","__idx":6},"children":["Markdoc object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["realm"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED"]},"."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["realm"]}," validates tags against the built-in Realm schema."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," parses and pairs Markdoc tags without a schema check."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["extend"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#extend-object"},"children":["Extend object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add your own tags on top of the chosen schema."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"extend-object","__idx":7},"children":["Extend object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tag names mapped to tag schemas."," ","Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagsFile"]},", or both."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tagsFile"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path to a YAML file that maps tag names to tag schemas."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":8},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"extends:\n  - recheck/markdown\nrecheck:\n  excludes:\n    - CHANGELOG.md\n  markdoc: true\n  rules:\n    recheck/line-length: off\n    recheck/readability-floor:\n      severity: warn\n      message: 'Readability (%s) is %s; expected between %s and %s.'\n      assertions:\n        metric:\n          formula: flesch-reading-ease\n          min: 30\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This config adds the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/markdown"]}," preset in the root ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]},"."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," block skips ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CHANGELOG.md"]},", turns on Markdoc-aware parsing, turns off one rule, and adds one rule."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-options","__idx":9},"children":["Related options"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/configuration/reference/extends"},"children":["extends"]}," lists the Recheck presets at the root of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/configuration/reference/rules"},"children":["rules"]}," configures API linting rules, which are separate from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck.rules"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":10},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Command reference for ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/recheck"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}]},"."]}]}]},"frontmatter":{},"tagList":["table"],"title":"recheck","lastModified":"2026-10-02T14:40:08.000Z"}