remark-lint-no-heading-indent

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

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-no-heading-indent

This package exports no identifiers. The default export is remarkLintNoHeadingIndent.

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:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoHeadingIndent from 'remark-lint-no-heading-indent'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoHeadingIndent)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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.

License

MIT © Titus Wormer