transform-markdown-links

Transform the links in a Markdown file

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
transform-markdown-links
2.0.05 years ago6 years agoMinified + gzip package size for transform-markdown-links in KB

Readme

transform-markdown-links
Travis npm
Transform the links in a Markdown file

Transforms the URLs of links in a Markdown file using a transform function.

Installation

npm install transform-markdown-links

Usage

import transformLinks from 'transform-markdown-links';

const input = 'This [link](page.md) will be transformed.';

transformLinks(input, (link, text) => link + '?hooray');
// => 'This [link](page.md?hooray) will be transformed.'

API

transformLinks(input, transform)

Transform the links in a Markdown string using a transform function. Returns a String of Markdown with transformed links.
  • input (String): Markdown input.
  • transform (Function): Callback to transform each link. Should return a string to change the link's URL, or undefined to leave it as-is. Gets these parameters:
- link (String): URL of the link. - text (String): text of the link.

Local Development

git clone https://github.com/gakimball/transform-markdown-links
cd transform-markdown-links
npm install
npm test

License

MIT © Geoff Kimball