textlint-rule-title-case

Textlint rule to ensure that titles are using AP/APA style. Based on ap-style-title-case.

The rules are:

Always capitalize the first word, even if it’s a stopword.
Always capitalize the last word, even if it’s a stopword.
Lowercase these words: a an and at but by for in nor of on or so the to up yet.

Installation

npm install textlint-rule-title-case

Then enable the rule in your .textlintrc:

{
  "rules": {
    "title-case": true
  }
}

Usage

textlint --fix --rule title-case Readme.md

Configuration

You can configure the rule in your .textlintrc:

{
  "rules": {
    "title-case": {
      // Apply these rules only for mentioned heading levels
      "headingLevels": [1, 2, 3],
      // Always use this casing for these words
      "exclude": [
        "npm",
        "webpack"
      ],
    }
  }
}

Other textlint rules

textlint-rule-apostrophe — correct apostrophe usage
textlint-rule-diacritics — words with diacritics
textlint-rule-stop-words — filler words, buzzwords and clichés
textlint-rule-terminology — tech terms

Change log

The change log can be found on the Releases page.

Contributing

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file.

sapegin/textlint-rule-title-case