Nifty Procrastination Machine

    textlint-rule-title-case

    2.0.0 • Public • Published

    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.

    Install

    npm i textlint-rule-title-case

    DownloadsWeekly Downloads

    42

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    6.87 kB

    Total Files

    4

    Last publish

    Collaborators

    • sapegin