markdownlint-config-iamnewton v1.0.1

Markdownlint Config

A shareable Markdownlint configuration for documentation.

Installation

npm install --save-dev markdownlint-config-iamnewton

Usage

In your project package.json add the following:

{
  "scripts": {
    "lint:markdown": "markdownlint --config ./node_modules/markdownlint-config-iamnewton/markdownlintrc.json"
  }
}

Rules

Check out the rules for markdownlint

Versioning

All modules, libraries, or frameworks use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes.
• MINOR version when you add functionality in a backward-compatible manner.
• PATCH version when you make backward-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.