.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-heading-increment
remark-lint
rule to warn when heading ranks increment with more than
1 at a time.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks the increase of headings.
When should I use this?
You can use this package to check the increase of headings.
Presets
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-heading-increment
In Deno with esm.sh
:
import remarkLintHeadingIncrement from 'https://esm.sh/remark-lint-heading-increment@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintHeadingIncrement from 'https://esm.sh/remark-lint-heading-increment@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintHeadingIncrement from 'remark-lint-heading-increment'
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(remarkLintHeadingIncrement)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-heading-increment .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-heading-increment",
…
]
}
…
API
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintHeadingIncrement
.
unified().use(remarkLintHeadingIncrement)
Warn when heading ranks increment with more than 1 at a time.
Parameters
There are no options.
Returns
Transform (Transformer
from unified
).
Recommendation
While markdown is not only used for HTML,
HTML accessibility guidelines state that headings should increment by one at
a time.
As in,
say the previous heading had a rank of 2 (so <h2>
),
then the following heading that is to be considered “inside” it should have
a rank of 3 (<h3>
).
Due to this,
when HTML output is a goal of the document,
it’s recommended that this rule is turned on.
Examples
ok.md
In
# Alpha
## Bravo
Out
No messages.
not-ok.md
In
# Charlie
### Delta
Out
3:1-3:10: Heading levels should increment by one level at a time
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-heading-increment@3
,
compatible with Node.js 12.
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.