https://github.com/martinheidegger/markdown-it-replace-link

markdown-it plugin for replacing links (image & text) in the markdown document.
https://github.com/martinheidegger/markdown-it-replace-link

Last synced: about 4 hours ago
JSON representation

markdown-it plugin for replacing links (image & text) in the markdown document.

• Host: GitHub
• URL: https://github.com/martinheidegger/markdown-it-replace-link
• Owner: martinheidegger
• License: mit
• Created: 2015-05-13T15:42:56.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-01-05T03:04:54.000Z (9 months ago)
• Last Synced: 2024-04-30T04:21:13.152Z (5 months ago)
• Language: JavaScript
• Size: 134 KB
• Stars: 52
• Watchers: 4
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# markdown-it-replace-link

> markdown-it plugin for replacing links (image & text) in the markdown document.

## Usage

#### Enable plugin

```js

var md = require('markdown-it')({

    html: true,

    linkify: true

})

.use(require('markdown-it-replace-link'), {

    processHTML: true, // defaults to false for backwards compatibility

    replaceLink: function (link, env, token, htmlToken) {

        return link + "?c=" + Date.now();

    }

})

```

#### Example

```md

[Hello](test)

```

and use this

```js

var md = require('markdown-it')({

    replaceLink: function (link, env, token, htmlToken) {

        return "http://me.com/" + link;

    }

}).use(require('markdown-it-replace-link'));

```

This will result in the link prefixed with the `http://me.com/` like:

```html

Hello

```


Both images and html links will be processed.

If using this in a browser, the script will create a variable 

`window.markdownitReplaceLink` that can be passed to `.use()`.

### Testing

To run the tests use:

```bash

npm run test

```

### License

[MIT](./LICENSE)