Awesome

textlint-rule-first-sentence-length

textlint rule that limit maximum length of First sentence of the section.

OK:

# Title

Short description.

text text text.

NG:

# Title

Long Long Long Long description. <= Lint Error

text text.

## Section 2

Long Long Long Long description. <= Lint Error

Install with npm:

npm install textlint-rule-first-sentence-length

Via .textlintrc(Recommended)

{
    "rules": {
        "first-sentence-length": true
    }
}

Via CLI

textlint --rule first-sentence-length README.md

max
- default: 50
- The total number of characters allowed on first paragraph of the sentence.
- Fist sentence.length should be <= 50.

{
    "rules": {
        "sentence-length": {
            "max": 50
        }
    }
}

書き出しの文は30字以下

書き出しの長さは、文全体が一目で見られる目安として「30字」と定めました。興味を引き、一気に読んでもらえるかは、書き出し文の印象にかかっています。

Install devDependencies and Run npm test:

npm i -d && npm test

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.