markdownlint-configuration

Markdownlint configuration enforces consistent Markdown style by defining rules in a .markdownlint.json or .markdownlint.yaml file at your project root. Create the file, enable or disable specific rules (like MD003 for heading style or MD013 for line length), and set per-rule options such as indentation or allowed formats. Run markdownlint against your Markdown files to validate compliance.

Markdownlint rules are individual checks that enforce Markdown formatting standards—examples include MD003 (heading style), MD007 (indentation), MD009 (trailing spaces), and MD035 (emphasis style). Customize each rule by setting its enabled state and parameters in your configuration file. Some rules accept style options (e.g., 'consistent', 'atx', 'setext') to match your documentation conventions.

Yes, markdownlint supports inline directives that disable or reconfigure rule checks within individual files. Use HTML comments like `<!-- markdownlint-disable MD003 -->` to turn off a rule for following content and `<!-- markdownlint-enable MD003 -->` to re-enable it. This lets you override global configuration for edge cases without modifying your configuration files.

Markdownlint configuration supports inheritance through the 'extends' property in JSON or YAML files, allowing you to reference a base configuration and override specific rules. This enables teams to maintain a shared rule set in a parent config file and extend it in project-specific files, reducing duplication while preserving local customization.

Markdownlint validates configuration against a JSON schema during runtime; if your configuration file contains syntax errors or invalid rule options, markdownlint will report schema validation failures. Test your configuration by running markdownlint on sample Markdown files to ensure rules apply as intended and syntax is correct.

Markdownlint configuration runs on Node.js projects and requires Node.js installed on your system. Configuration files use standard JSON or YAML formats compatible with any Node.js version that markdownlint supports. No additional dependencies are required beyond markdownlint itself to define and apply rules.