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-no-heading-indent
Warn when a heading is indented.
Fix
remark-stringify
removes all unneeded indentation before headings.
See Using remark to fix your Markdown on how to automatically fix warnings for this rule.
Presets
This rule is not included in any default preset
Example
ok.md
In
Note: ·
represents a space.
#·Hello world
Foo
-----
#·Hello world·#
Bar
=====
Out
No messages.
not-ok.md
In
Note: ·
represents a space.
···# Hello world
·Foo
-----
·# Hello world #
···Bar
=====
Out
1:4: Remove 3 spaces before this heading
3:2: Remove 1 space before this heading
6:2: Remove 1 space before this heading
8:4: Remove 3 spaces before this heading
Install
npm:
npm install remark-lint-no-heading-indent
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-heading-indent",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-heading-indent 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-no-heading-indent'))
.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.