markdown-link-extractor

extracts links from markdown texts

Usage no npm install needed!

<script type="module">
  import markdownLinkExtractor from 'https://cdn.skypack.dev/markdown-link-extractor';
</script>

README

markdown-link-extractor

Extracts links from markdown texts.

Installation

$ npm install --save markdown-link-extractor

API

markdownLinkExtractor(markdown, extended=false)

Parameters:

  • markdown text in markdown format.
  • extended enables extended output. Returns an object with metadata rather than the URL as a string (when extended===false)

Returns:

  • an array containing the URLs from the links found.
  • when extended === false array contains strings
  • when extended === true array contains objects

Examples

const { readFileSync } = require('fs');
const markdownLinkExtractor = require('markdown-link-extractor');

const markdown = readFileSync('README.md', {encoding: 'utf8'});

const links = markdownLinkExtractor(markdown, false);
links.forEach(link => console.log(link));

const details = markdownLinkExtractor(markdown, true);
details.forEach(detail => console.log(detail));

Extended output format:

{ type: 'link',
  raw:
   '[LICENSE.md](https://github.com/tcort/markdown-link-extractor/blob/master/LICENSE.md)',
  href:
   'https://github.com/tcort/markdown-link-extractor/blob/master/LICENSE.md',
  title: null,
  text: 'LICENSE.md',
  tokens: [ { type: 'text', raw: 'LICENSE.md', text: 'LICENSE.md' } ] }

Testing

npm test

License

See LICENSE.md