{"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"]}," command lints Markdown files for prose and structure problems."," ","It checks headings, sentences, links, images, and Markdoc tags against a set of rules."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rules come from presets, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/markdown"]},", that you add to the root ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"."," ","The ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/configuration/reference/recheck"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," block"]}," adjusts those rules."," ","With no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},", the command uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/markdown"]},"."," ","With a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," that has neither, the command checks nothing and says so."," ","The command reads the root ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," config; settings under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apis.<name>"]}," are not used."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"usage","__idx":2},"children":["Usage"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"redocly recheck\nredocly recheck <paths>...\nredocly recheck [--fix]\nredocly recheck [--readability]\nredocly recheck [--generate-baseline]\nredocly recheck [--generate-markdoc-schema] [--from=<path>...] [--output=<path>] [--check]\nredocly recheck --help\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"One action per run"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--readability"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--generate-baseline"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--generate-markdoc-schema"]}," each replace the default lint action."," ","Use at most one of them in a run."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--fix"]}," works with the default lint action only."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":3},"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":["paths"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Files or directories to lint. Default value is the current directory."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--check"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fail when the generated schema differs from the file in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--output"]},". Use with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--generate-markdoc-schema"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path to the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/configuration"},"children":["configuration file"]},"."]}]},{"$$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":["Apply fixes to the Markdown files. Alias: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-f"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Format for the report.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Possible values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["table"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sarif"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["github-actions"]},". Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["table"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--from"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Module paths to read Markdoc tags from. Use with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--generate-markdoc-schema"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--generate-baseline"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write a baseline file from the current errors."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--generate-markdoc-schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate a Markdoc tag schema from theme modules. Needs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--from"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--output"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--help"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show help."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--lint-config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specify the severity level for the configuration file.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Possible values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},". Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--max-problems"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum number of problems in the report; applies to every format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--output"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Output file for the generated schema."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--readability"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Report readability scores instead of lint findings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--rule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run only these rules. Alias: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-r"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--skip-rule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip these rules."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--stats"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Print statistics per rule. Alias: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-s"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--summary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Print a summary of the run.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Possible values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--summary-path"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write the summary to this file."]}]},{"$$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":["Run only rules with these tags."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Show version number."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":4},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"lint-a-folder","__idx":5},"children":["Lint a folder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a preset to the root ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extends"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"extends:\n  - recheck/markdown\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Then run the command on a folder:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"redocly recheck docs\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The command lints every Markdown file under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs"]}," with the rules from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/markdown"]},"."," ","The report goes to stdout and progress messages go to stderr."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"turn-off-a-rule","__idx":6},"children":["Turn off a rule"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the rule to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck"]}," block:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"extends:\n  - recheck/markdown\nrecheck:\n  rules:\n    recheck/line-length: off\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The run applies every rule from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/markdown"]}," except ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recheck/line-length"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"annotate-a-pull-request","__idx":7},"children":["Annotate a pull request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"redocly recheck docs --format=github-actions\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In a GitHub Actions workflow, this format adds each finding as an annotation on the changed line."," ","An error becomes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["::error"]},", a warning ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["::warning"]},", and an info finding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["::notice"]},"."," ","Each finding is one line of output:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"::error title=recheck/single-h1,file=docs/index.md,line=2,endLine=2,col=1,endColumn=1::Multiple top-level headings in the same document\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"use-a-baseline","__idx":8},"children":["Use a baseline"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A baseline records the current errors."," ","Later runs report only errors that the baseline does not list."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"redocly recheck docs --generate-baseline\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The command writes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".redocly.recheck-baseline.yaml"]}," next to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"."," ","Commit the file."," ","Later runs pick it up automatically."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you fix errors, generate the baseline again and commit the smaller file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"check-readability","__idx":9},"children":["Check readability"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"redocly recheck docs --readability\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The command prints readability scores for each Markdown file instead of lint findings."]}]},"frontmatter":{},"tagList":["admonition","html"],"title":"recheck","lastModified":"2026-10-02T14:40:08.000Z"}