README.md

jest-runner-markdownlint

Markdown Lint runner for Jest

Usage

Install

Install jest (Jest 21+) and jest-runner-markdownlint

yarn add --dev jest jest-runner-markdownlint

Add it to your Jest config

In your package.json

{
  "jest": {
    "runner": "jest-runner-markdownlint",
    "displayName": "Markdown Lint",
    "testMatch": ["<rootDir>/src/**/*.md"],
    "moduleFileExtensions": ["md"]
  }
}

Or in jest.config.js

module.exports = {
  runner: 'jest-runner-markdownlint',
  displayName: 'Markdown Lint',
  testMatch: ['<rootDir>/src/**/*.md'],
  moduleFileExtensions: ['md']
}

Run Jest

yarn jest