blob: 559a6ead72ce52ec1d5768fc1e79c167d7278ccc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
# `@11ty/posthtml-urls`
PostHTML plugin for transforming URLs. This is a fork of [`posthtml/posthtml-urls`](https://github.com/posthtml/posthtml-urls).
## Installation
[Node.js](http://nodejs.org) `>= 6` is required. To install, type this at the command line:
```shell
npm install @11ty/posthtml-urls
```
## Usage
```js
const posthtml = require('posthtml');
const urls = require('@11ty/posthtml-urls');
const options = {
eachURL: (url, attr, tagName) => `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
### `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`.
### `filter`
Type: `Object`
Default value: [`{…}`](https://github.com/posthtml/posthtml-urls/blob/master/lib/defaultOptions.js)
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](https://npmjs.com/posthtml-postcss) and [postcss-url](https://npmjs.com/postcss-url).
|
