remark-lint-no-empty-sections

remark-lint-no-empty-sections

This remark-lint rule was created for free-programming-books-lint to enforce free-programming-books formatting guidelines.

This rule checks that every ([#]+)heading has some content. This content can be anything: a lower-level heading, a higher-level heading, text, list, etc. It will warn when it detects an n-level heading without content followed by another n-level heading.

Examples

<!-- Invalid -->

# A

## B (this section is empty!)

<!-- Invalid -->

# A

## B (this section is empty!)

## C

Some content.

<!-- Valid -->

# A

## C

Some content.

Using the rule

Via .remarkrc

npm install -g remark-cli
npm install remark-lint remark-lint-no-empty-sections

Then, set up your .remarkrc:

{
  "plugins": [
    "lint",
    "lint-no-empty-sections"
  ]
}

Now you can use the following command to run the lint:

remark xxx.md

Via CLI

npm install -g remark-cli
npm install remark-lint remark-lint-no-empty-sections
remark -u lint -u lint-no-empty-sections xxx.md