markdownlint

A tool to check markdown files and flag style issues.

Version

0.4.0

Runtime

Ruby 2.6.2

Supported Languages

Markdown

Official Documentation

https://github.com/markdownlint/markdownlint

YAML Configuration

markdownlint:

  • input:

    Patterns to include in execution and reports.

  • ignore:

    Patterns to exclude from execution and reports.

  • auto-fix:

    N/A

  • config-file:

    Alias of --config option.

  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.25 CPU with 960 MiB RAM.

  • options:

    Below is the list of options that are supported:

    -c, --config FILE                The configuration file to use
    -g, --git-recurse                Only process files known to git when given a directory
    -i, --[no-]ignore-front-matter   Ignore YAML front matter
    -r, --rules RULE1,RULE2          Only process these rules
    -u, --rulesets RULESET1,RULESET2 Specify additional ruleset files to load
    -a, --[no-]show-aliases          Show rule alias instead of rule ID when viewing rules
    -w, --[no-]warnings              Show kramdown warnings
    -d, --skip-default-ruleset       Don't load the default markdownlint ruleset
    -s, --style STYLE                Load the given style
    -t, --tags TAG1,TAG2             Only process rules with these tags
    
  • thresholds:

    • num-issues:

      No tool specific severity levels are available.

  • experimental:

    • incremental:

      true/false

      Note: The incremental analysis is disabled if any kinds of configuration files are changed. The files recognized as configuration files are as follows:

      • Configuration files:
        • Files specified in config-file field
        • Files specified to -c, --config options
        • If none of the above configuration files are found:
          • .mdlrc at the repository root
      • Ruleset files:
        • Files specified to -u, --rulesets options
      • Style files:
        • Files specified to -s, --style options

YAML Examples

  • With default options:

    inspecode:
      markdownlint: default
    
  • With custom machine:

    inspecode:
      markdownlint:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With custom options:

    inspecode:
      markdownlint:
        options: [-w, -d]
    
  • With a configuration file:

    inspecode:
      markdownlint:
        config-file: ./my-mdlrc
    

    The above configuration is equivalent to:

    inspecode:
      markdownlint:
        options:
          --config: ./my-mdlrc
    

results matching ""

    No results matching ""