remark-lint rule to warn when extra whitespace is used between hashes and content in headings.
Contents
What is this?
This package checks whitespace between hashes and content.
When should I use this?
You can use this package to check that headings are consistent.
Presets
This plugin is included in the following presets:
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-heading-content-indent
In Deno with esm.sh:
import remarkLintNoHeadingContentIndent from 'https://esm.sh/remark-lint-no-heading-content-indent@5'
In browsers with esm.sh:
<script type="module">
import remarkLintNoHeadingContentIndent from 'https://esm.sh/remark-lint-no-heading-content-indent@5?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoHeadingContentIndent from 'remark-lint-no-heading-content-indent'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoHeadingContentIndent)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-heading-content-indent .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-heading-content-indent",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoHeadingContentIndent.
Warn when extra whitespace is used between hashes and content in headings.
Parameters
There are no options.
Returns
Transform (Transformer from unified).
Recommendation
One space is required and more than one space has no effect. Due to this, it’s recommended to turn this rule on.
Fix
remark-stringify formats headings with one space.
Examples
ok.md
In
#␠Mercury
##␠Venus␠##
␠␠##␠Earth
Setext headings are not affected:
␠Mars
=====
␠Jupiter
--------
Out
No messages.
not-ok.md
In
#␠␠Mercury
##␠Venus␠␠##
␠␠##␠␠␠Earth
Out
1:4: Unexpected `2` spaces between hashes and content, expected `1` space, remove `1` space
3:11: Unexpected `2` spaces between content and hashes, expected `1` space, remove `1` space
5:8: Unexpected `3` spaces between hashes and content, expected `1` space, remove `2` spaces
empty-heading.md
In
#␠␠
Out
1:4: Unexpected `2` spaces between hashes and content, expected `1` space, remove `1` space
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-no-heading-content-indent@5, compatible with Node.js 16.
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