mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 19:58:38 +03:00
| .. | ||
| index.js | ||
| package.json | ||
| readme.md | ||
remark-lint-heading-style
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:
| Preset | Setting |
|---|---|
remark-preset-lint-consistent |
'consistent' |
remark-preset-lint-markdown-style-guide |
'atx' |
Example
valid.md
When configured with 'atx'.
In
# Alpha
## Bravo
### Charlie
Out
No messages.
valid.md
When configured with 'atx-closed'.
In
# Delta ##
## Echo ##
### Foxtrot ###
Out
No messages.
valid.md
When configured with 'setext'.
In
Golf
====
Hotel
-----
### India
Out
No messages.
invalid.md
In
Juliett
=======
## Kilo
### Lima ###
Out
4:1-4:8: Headings should use setext
6:1-6:13: Headings should use setext
Install
npm install remark-lint-heading-style
Usage
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));
});