Skip to content
This repository has been archived by the owner on Mar 29, 2021. It is now read-only.

A simple rule for checking the heading length in Markdown documents

License

Notifications You must be signed in to change notification settings

zerok/remark-lint-heading-length

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

remark-lint-heading-length

This rule for remark-lint enforces that headings have a certain number of words. By default, headings must have at least 2 words and at most 10. You can configure this length like this:

{
    "plugins": [
        "remark-preset-lint-recommended",
        ["remark-lint-heading-length", ["error", {
            "min": 3,
            "max": 12
        }]]
    ]
}

This would enforce at least 3 and at most 12 words within the heading of your Markdown files.

About

A simple rule for checking the heading length in Markdown documents

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published