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 ([#]+)title has some content. This content can be anything: a lower-level title, a higher-level title, text, list, etc. It will only complain if you have a n-level title without content followed by another n-level title.

<!-- Invalid -->

# A

## B (this section is empty!)

## C

<!-- Valid -->

# A

## C

Using the rule

Via .remarkrc

npm install -g remark
npm install -g remark-lint
npm install remark-lint-no-empty-sections # local install!

Then, set up your .remarkrc:

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

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

remark --no-stdout xxx.md

Via CLI

npm install -g remark
npm install -g remark-lint
npm install -g remark-lint-no-empty-sections # global install!
remark --no-stdout -u remark-lint="external:[\"remark-lint-no-empty-sections\"]" xxx.md

Note that the lint=<lint_options> option only works with remark >= 1.1.1.

This README.md is based on this one by @chcokr (MIT).