mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
.. | ||
index.js | ||
package.json | ||
readme.md |
remark-lint-no-inline-padding
Warn when phrasing content is padded with spaces between their markers and content.
Warns for emphasis, strong, delete, image, and link.
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
|
remark-preset-lint-recommended |
Example
ok.md
In
Alpha, *bravo*, _charlie_, [delta](http://echo.fox/trot)
Out
No messages.
not-ok.md
In
Alpha, * bravo *, _ charlie _, [ delta ](http://echo.fox/trot)
Out
1:8-1:17: Don’t pad `emphasis` with inner spaces
1:19-1:30: Don’t pad `emphasis` with inner spaces
1:32-1:63: Don’t pad `link` with inner spaces
Install
npm:
npm install remark-lint-no-inline-padding
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-inline-padding",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-inline-padding 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-inline-padding'))
.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.