unified

Project: remarkjs/remark-lint

Package: remark-lint-heading-style@2.0.1

  1. Dependencies: 4·Dependents: 18
  2. remark-lint rule to warn when heading style violates the given style
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. heading 26
  6. style 10

remark-lint-heading-style

Build Coverage Downloads Size Sponsors Backers Chat

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

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

'consistent' detects the first used heading style and warns when subsequent headings use different styles.

Fix

remark-stringify formats headings as ATX by default. This can be configured with the setext and closeAtx options.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-consistent'consistent'
remark-preset-lint-markdown-style-guide'atx'

Example

ok.md

When configured with 'atx'.

In
# Alpha

## Bravo

### Charlie
Out

No messages.

ok.md

When configured with 'atx-closed'.

In
# Delta ##

## Echo ##

### Foxtrot ###
Out

No messages.

ok.md

When configured with 'setext'.

In
Golf
====

Hotel
-----

### India
Out

No messages.

not-ok.md
In
Juliett
=======

## Kilo

### Lima ###
Out
4:1-4:8: Headings should use setext
6:1-6:13: Headings should use setext

Install

npm:

npm install remark-lint-heading-style

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-heading-style",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-heading-style readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-heading-style'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file))
   })

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer