mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
.. | ||
index.js | ||
package.json | ||
readme.md |
remark-lint-maximum-heading-length
Warn when headings are too long.
Options: number
, default: 60
.
Ignores Markdown syntax, only checks the plain text content.
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
Example
not-ok.md
When configured with 40
.
In
# Alpha bravo charlie delta echo foxtrot golf hotel
Out
1:1-1:52: Use headings shorter than `40`
ok.md
In
# Alpha bravo charlie delta echo foxtrot golf hotel
# ![Alpha bravo charlie delta echo foxtrot golf hotel](http://example.com/nato.png)
Out
No messages.
Install
npm:
npm install remark-lint-maximum-heading-length
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-maximum-heading-length",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-maximum-heading-length 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-maximum-heading-length'))
.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.