Renault Digital Markdown Lint config

• Installation
• Usage
• Examples
• Contribute

Installation

Using npm :

npm install --save-dev @renault-digital/mdlint-config

Or using yarn :

yarn add --dev @renault-digital/mdlint-config

Usage

Please follow configure mdlint for configuration.

The follow rules are available (you can combine them) :

• @renault-digital : General Markdown rules

A basic usage will be in a file .markdownlint.json:

{
  "extends": "./node_modules/@renault-digital/mdlint-config/markdownlint.json"
}

And after :

yarn markdownlint .

Examples

Bellow are some recommended usage.

A common usage

.markdownlint.json:

{
  "extends": "./node_modules/@renault-digital/mdlint-config/markdownlint.json"
}

Contribute

Proposing changes

Major changes should be discussed GitHub.

Semver policy

Same approach as in mdlint, see Semantic Versioning Policy.