https://github.com/brechtcs/rehype-urls

Rehype plugin to rewrite URLs
https://github.com/brechtcs/rehype-urls

Last synced: about 11 hours ago
JSON representation

Rehype plugin to rewrite URLs

• Host: GitHub
• URL: https://github.com/brechtcs/rehype-urls
• Owner: brechtcs
• License: apache-2.0
• Created: 2018-12-06T16:29:33.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T18:57:25.000Z (over 1 year ago)
• Last Synced: 2024-11-07T18:08:26.866Z (9 days ago)
• Language: JavaScript
• Homepage:
• Size: 10.7 KB
• Stars: 14
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rehype-urls

Rehype plugin to rewrite URLs of `href` and `src` attributes.

## Installation

```sh

npm install rehype-urls

```

## Usage

Given this markup:

```html

  

  page

  link

```

You can use the following script:

```js

var rehype = require('rehype')

var urls = require('rehype-urls')

rehype()

  .use(urls, removeBaseUrl)

  .process(input, handleOutput)

function removeBaseUrl (url) {

  if (url.host === 'internal.site') {

    return url.path

  }

}

```

Which will transform it into:

```html

  

  page

  link

```

You can also pass in an object:

```js

rehype()

  .use(urls, { transform: removeBaseUrl })

  .process(input, handleOutput)

```

### Mutate nodes

It's also possible to mutate the URL nodes directly. This example will add `target="_blank"` to any external links:

```js

var rehype = require('rehype')

var urls = require('rehype-urls')

rehype()

  .use(urls, blankExternal)

  .process(input, handleOutput)

function blankExternal (url, node) {

  if (url.host !== 'internal.site') {

    node.properties.target = '_blank'

  }

}

```

## License

Apache-2.0