Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

remark-lint-no-heading-content-indent

Package Overview
Dependencies
Maintainers
2
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-lint-no-heading-content-indent

remark-lint rule to warn when heading content is indented

  • 2.0.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
52K
decreased by-55.3%
Maintainers
2
Weekly downloads
 
Created
Source

remark-lint-no-heading-content-indent

Build Coverage Downloads Size Sponsors Backers Chat

Warn when content of headings is indented.

Fix

remark-stringify removes all unneeded padding around content in headings.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-recommended

Example

ok.md
In

Note: · represents a space.

#·Foo

## Bar·##

  ##·Baz

Setext headings are not affected.

Baz
===
Out

No messages.

not-ok.md
In

Note: · represents a space.

#··Foo

## Bar··##

  ##··Baz
Out
1:4: Remove 1 space before this heading’s content
3:7: Remove 1 space after this heading’s content
5:7: Remove 1 space before this heading’s content
empty-heading.md
In

Note: · represents a space.

#··
Out

No messages.

tight.md
In

Note: · represents a space.

In pedantic mode, headings without spacing can also be detected:

##No spacing left, too much right··##
Out
3:3: Add 1 space before this heading’s content
3:34: Remove 1 space after this heading’s content

Install

npm:

npm install remark-lint-no-heading-content-indent

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-heading-content-indent",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-heading-content-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-content-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.

License

MIT © Titus Wormer

Keywords

FAQs

Package last updated on 02 Jul 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc