.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-no-heading-indent
remark-lint
rule to warn when headings are indented.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks the indent of headings.
When should I use this?
You can use this package to check that headings are consistent.
Presets
This plugin is not included in presets maintained here.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-heading-indent
In Deno with esm.sh
:
import remarkLintNoHeadingIndent from 'https://esm.sh/remark-lint-no-heading-indent@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoHeadingIndent from 'https://esm.sh/remark-lint-no-heading-indent@4?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoHeadingIndent from 'remark-lint-no-heading-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(remarkLintNoHeadingIndent)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-heading-indent .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-heading-indent",
…
]
}
…
API
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoHeadingIndent
.
unified().use(remarkLintNoHeadingIndent)
Warn when headings are indented.
Parameters
There are no options.
Returns
Transform (Transformer
from unified
).
Recommendation
There is no specific handling of indented headings (or anything else) in markdown. While it is possible to use an indent to headings on their text:
# One
## Two
### Three
#### Four
…such style is uncommon, a bit hard to maintain, and it’s impossible to add a heading with a rank of 5 as it would form indented code instead. Hence, it’s recommended to not indent headings and to turn this rule on.
Fix
remark-stringify
formats headings without indent.
Examples
ok.md
In
#␠Hello world
Foo
-----
#␠Hello world␠#
Bar
=====
Out
No messages.
not-ok.md
In
␠␠␠# 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
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-indent@4
,
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.