docslint

0.4.0 • Public • Published

docslint Build Status

Lint and fix docs simpler

Under the hood docslint uses textlint with predefined rule set. It’s a simple zero-config tool that works out of the box like standard and xo.

Install

npm install --global docslint

Usage

docslint --help
 
  Lint and fix docs simpler
 
  Usage
    docslint [file|glob ...]
 
  Options
    --fix      Automatically fix issues
    --disable  Rules to disable, can be set multiple times
 
  Examples
    docslint
    docslint readme.md
    docslint *.md !readme.md
    docslint --fix
    docslint --disable terminology

Rules

Base configuration contains following rules:

You can disable any rule by running docslint with --disable <rule> flag.

License

MIT

Package Sidebar

Install

npm i docslint

Weekly Downloads

3

Version

0.4.0

License

MIT

Last publish

Collaborators

  • andrepolischuk