Have ideas to improve npm?Join in the discussion! »

remark-inline-links

5.0.0 • Public • Published

remark-inline-links

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to transform references and definitions into normal links and images.

Note!

This plugin is ready for the new parser in remark (remarkjs/remark#536). The current and previous versions of the plugin work with the current and previous versions of remark.

Install

npm:

npm install remark-inline-links

Use

Say we have the following file, example.md:

[foo], [foo][][bar][foo].
 
![foo], ![foo][]![bar][foo].
 
[foo]: http://example.com "Example Domain"

And our script, example.js, looks as follows:

var fs = require('fs')
var remark = require('remark')
var links = require('remark-inline-links')
 
remark()
  .use(links)
  .process(fs.readFileSync('example.md'), function(err, file) {
    if (err) throw err
    console.log(String(file))
  })

Now, running node example yields:

[foo](http://example.com "Example Domain")[foo](http://example.com "Example Domain")[bar](http://example.com "Example Domain").
 
![foo](http://example.com "Example Domain")![foo](http://example.com "Example Domain")![bar](http://example.com "Example Domain").

API

remark().use(inlineLinks)

Plugin to transform references and definitions into normal links and images.

Security

Use of remark-inline-links does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

Related

  • remark-bookmarks — Link manager
  • remark-reference-links — Reverse of remark-inline-links, thus rewriting normal links and images into references and definitions
  • remark-defsplit — Practically the same as remark-reference-links, but with URI-based identifiers instead of numerical ones
  • remark-unlink — Remove all links, references and definitions

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

Install

npm i remark-inline-links

DownloadsWeekly Downloads

1,742

Version

5.0.0

License

MIT

Unpacked Size

8.62 kB

Total Files

4

Last publish

Collaborators

  • avatar
  • avatar