@textlint-rule/textlint-rule-google-articles

Reference: Articles (a, an, the)  |  Google Developer Documentation Style Guide  |  Google Developers

Install

Install with npm:

npm install @textlint-rule/textlint-rule-google-articles

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "@textlint-rule/google-articles": true
    }
}

Via CLI

textlint --rule @textlint-rule/google-articles README.md

Options

Specify article by a and an.

{
    "rules": {
        "@textlint-rule/google-articles": {
          "a": ["forceAWord"],
          "an":["forceAnWord"]
        }
    }
}

FAQ

Wrong error

To improve classifier, please file issue to

• azu/english-article-classifier: Classifier english article(a, an).

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

• github/azu
• twitter/azu_re

License

MIT © azu