andrepolischuk / docslint

Lint and fix docs simpler

docslint

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:

• common-misspellings — check common misspellings
• apostrophe — check and fix correct apostrophe usage
• diacritics — check and fix the usage of diacritics
• stop-words — find filler words, buzzwords and clichés
• terminology — check and fix correct terms spelling
• no-dead-link — check if all links are available or not
• no-start-duplicated-conjunction — check no start with duplicated conjunction
• real-symbols — check and fix symbols
• write-good — naive linter for English prose for developers
• en-capitalization — check and fix capitalization

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

License

MIT