Textlint rule to ensure that titles are using AP/APA style
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig
.eslintignore
.eslintrc
.gitignore
.travis.yml
Contributing.md
License.md
Readme.md
index.js
package-lock.json
package.json
test.js

Readme.md

textlint-rule-title-case

textlint fixable rule Build Status npm

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": {
      // Always use this casing for these words
      "exclusions": [
        "npm",
        "webpack"
      ],
    }
  }
}

Read more about configuring textlint.

Other textlint rules

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.