https://github.com/andrepolischuk/docslint

Lint and fix docs simpler
https://github.com/andrepolischuk/docslint

docs fix lint text textlint

Last synced: 2 months ago
JSON representation

Lint and fix docs simpler

• Host: GitHub
• URL: https://github.com/andrepolischuk/docslint
• Owner: andrepolischuk
• License: mit
• Created: 2017-12-07T11:55:52.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-13T11:53:47.000Z (about 7 years ago)
• Last Synced: 2024-10-12T04:23:26.365Z (3 months ago)
• Topics: docs, fix, lint, text, textlint
• Language: JavaScript
• Size: 182 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docslint [![Build Status][travis-image]][travis-url]

> Lint and fix docs simpler

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

![](screenshot.png)

## Install

```sh

npm install --global docslint

```

## Usage

```sh

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](https://github.com/andrepolischuk/docslint/blob/master/lib/createConfig.js#L20-L36) contains following rules:

* [`common-misspellings`](https://github.com/io-monad/textlint-rule-common-misspellings) — check common misspellings

* [`apostrophe`](https://github.com/sapegin/textlint-rule-apostrophe) — check and fix correct apostrophe usage

* [`diacritics`](https://github.com/sapegin/textlint-rule-diacritics) — check and fix the usage of diacritics

* [`stop-words`](https://github.com/sapegin/textlint-rule-stop-words) — find filler words, buzzwords and clichés

* [`terminology`](https://github.com/sapegin/textlint-rule-terminology) — check and fix correct terms spelling

* [`no-dead-link`](https://github.com/nodaguti/textlint-rule-no-dead-link) — check if all links are available or not

* [`no-start-duplicated-conjunction`](https://github.com/azu/textlint-rule-no-start-duplicated-conjunction) — check no start with duplicated conjunction

* [`real-symbols`](https://github.com/andrepolischuk/textlint-rule-real-symbols) — check and fix symbols

* [`write-good`](https://github.com/nodaguti/textlint-rule-write-good) — naive linter for English prose for developers

* [`en-capitalization`](https://github.com/textlint-rule/textlint-rule-en-capitalization) — check and fix capitalization

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

## License

MIT

[travis-url]: https://travis-ci.org/andrepolischuk/docslint

[travis-image]: https://travis-ci.org/andrepolischuk/docslint.svg?branch=master

[textlint]: https://github.com/textlint/textlint

[standard]: https://github.com/standard/standard

[xo]: https://github.com/sindresorhus/xo