Package Exports

remark-lint-heading-style

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 (remark-lint-heading-style) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-heading-style

Warn when a heading does not conform to a given style.

Options: string, either 'consistent', 'atx', 'atx-closed', or 'setext', default: 'consistent'.

The default value, consistent, detects the first used heading style, and will warn when a subsequent heading uses a different style.

Install

npm install --save remark-lint-heading-style

Example

When this rule is 'atx', the following file valid.md is ok:

<!--Also valid when `consistent`-->

# Alpha

## Bravo

### Charlie

When this rule is 'atx-closed', the following file valid.md is ok:

<!--Also valid when `consistent`-->

# Delta ##

## Echo ##

### Foxtrot ###

When this rule is 'setext', the following file valid.md is ok:

<!--Also valid when `consistent`-->

Golf
====

Hotel
-----

### India

When this rule is turned on, the following file invalid.md is not ok:

<!--Always invalid.-->

Juliett
=======

## Kilo

### Lima ###

6:1-6:8: Headings should use setext
8:1-8:13: Headings should use setext