Package Exports

textlint-rule-incremental-headers

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (textlint-rule-incremental-headers) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

textlint-rule-incremental-headers

このtextlint-ruleプラグインは次の２つのルールを検査します。

ページの始まりの見出しは#(h1)から始まる。
見出しの深さ(h1, h2, h3など)は必ず１つずつ増加する。(h1, h3のように急に深くならない)

Example

# この文章は

ルールに従っているので

## 問題

## ありません

### すばらしい

ですね

## この文章は

h2から始まっているので

## 問題です

# この文章は

以下のように

### 突然

#の数が多い(深い)見出しが付いているので

### 問題です

Installation

プラグインのインストールは以下のように行います。

まずnpmのライブラリとしてインストールを行います。

npm install -D textlint textlint-rule-incremental-headers

その後、.textlintrcで以下のようにpluginsを記述します。

{
    "plugins": [
        "incremental-headers"
    ]
}