posthtml-urls

    1.0.0 • Public • Published

    posthtml-urls NPM Version Build Status Dependency Status

    PostHTML plugin for transforming URLs.

    Installation

    Node.js >= 4 is required. To install, type this at the command line:

    npm install posthtml-urls

    Usage

    const posthtml = require('posthtml');
    const urls = require('posthtml-urls');
     
    const options = {
      eachURL: function(url, attr, element) {
        return `http://domain.com/${url}`;
      }
    };
     
    posthtml()
    .use( urls(options) )
    .process('<a href="link.html">link</a>')
    .then(result => console.log(result.html));
     
    //-> <a href="http://domain.com/link.html">link</a>

    Options

    options.eachURL

    Type: Function
    Default value: undefined
    A callback function ran for each URL value found. You can return either a synchronous value or a Promise.

    options.filter

    Type: Object
    Default value:
    The elements and attributes for which to search. An attribute value can optionally be a function, for deeper filtering.

    FAQ

    1. How can I filter <style> elements and style attributes?
      Use posthtml-postcss and postcss-url.

    Install

    npm i posthtml-urls

    DownloadsWeekly Downloads

    6,362

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • stevenvachon