URL Parameters

Add parameters to URLs

[![Version][npm-version-shield]][npm] [![License][license-shield]][license] [![Build][travis-ci-shield]][travis-ci] [![Downloads][npm-stats-shield]][npm-stats]

## About This is a PostHTML plugin that allows you to add parameters to URLs. ## Install ``` $ npm i posthtml posthtml-url-parameters ``` ## Usage ```js const posthtml = require('posthtml') const urlParams = require('posthtml-url-parameters') posthtml([ urlParams({ parameters: { foo: 'bar', baz: 'qux' } }) ]) .process('Test') .then(result => console.log(result.html))) // Test ``` ## Configuration ### `parameters` Default: `undefined` Object containing parameter name (key) and its value. Example: ```js require('posthtml-url-parameters')({ parameters: { utm_source: 'Campaign', '1stDraft': true } }) ``` ### `tags` Default: `[a]` Array of tag names to process. Only URLs inside `href=""` attributes of tags in this array will be processed. Example: ```js require('posthtml-url-parameters')({ tags: ['a', 'link'], // ... }) ``` ### `qs` Default: `undefined` Options to pass to `query-string` - see available options [here](https://github.com/sindresorhus/query-string#stringifyobject-options). For example, you can disable encoding: ```js const posthtml = require('posthtml') const urlParams = require('posthtml-url-parameters') posthtml([ urlParams({ parameters: { foo: '@Bar@' }, qs: { encode: false } }) ]) .process('Test') .then(result => console.log(result.html))) // Test ``` [npm]: https://www.npmjs.com/package/posthtml-url-parameters [npm-version-shield]: https://img.shields.io/npm/v/posthtml-url-parameters.svg [npm-stats]: http://npm-stat.com/charts.html?package=posthtml-url-parameters [npm-stats-shield]: https://img.shields.io/npm/dt/posthtml-url-parameters.svg [travis-ci]: https://travis-ci.org/posthtml/posthtml-url-parameters/ [travis-ci-shield]: https://img.shields.io/travis/posthtml/posthtml-url-parameters/master.svg [license]: ./LICENSE [license-shield]: https://img.shields.io/npm/l/posthtml-url-parameters.svg