Package Exports
- remark-lint-no-literal-urls
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-literal-urls) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
remark-lint-no-literal-urls
Warn for literal URLs in text.
URLs are treated as links in some Markdown vendors, but not in others.
To make sure they are always linked, wrap them in <
(less than) and >
(greater than).
Fix
remark-stringify
never creates literal URLs and always uses <
(less than) and >
(greater than).
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:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
|
remark-preset-lint-recommended |
Example
ok.md
In
<http://foo.bar/baz>
Out
No messages.
not-ok.md
In
http://foo.bar/baz
Out
1:1-1:19: Don’t use literal URLs without angle brackets
Install
npm:
npm install remark-lint-no-literal-urls
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-literal-urls",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-literal-urls 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-literal-urls'))
.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.