martinheidegger / markdown-it-replace-link Goto Github PK

View Code? Open in Web Editor NEW

52.0 4.0 15.0 137 KB

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

License: MIT License

JavaScript 100.00%

markdown-it-replace-link's Introduction

markdown-it-replace-link

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

Usage

Enable plugin

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

[Hello](test)

and use this

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:

<p><a href="http://me.com/test">Hello</a></p>

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:

npm run test

License

MIT

markdown-it-replace-link's People

Contributors

Stargazers

Watchers

Forkers

gerhobbelt dereks fov42550564 gaybro8777 aleedy 19hours mbalex99 it-shutong gjieoo kkpan11 michaelhthomas ijortengab

markdown-it-replace-link's Issues

HTML child rendering

I just stumbled around an issue with the rendering of mixed html code. So, for example, when processHTML is active and I add some html to a markdown file, like this:

<span class="test">abc</span>

it renders the children outside of the element, thus resulting in:

<span class="test"></span>abc

It seems, like this behavior is somehow expected, as you've included the following test case:

expect(md.render('<a href="hi"><img src="ho"></a>')).to.equal('<p><a href="http://me.com/hi"></a><img src="html-image/ho"></p>\n')

Is this also an issue with the test or is it actual expected behavior? It seems to only affect html_inline, as closes the html tag always in child 1 (probably due to the Dom rendering the "incorrect" unclosed element closed).

Browser version in ./dist/?

I am using markdown-it in the browser and would like to use this plugin.

The documentation shows using require(), which doesn't work in my browser.

[...].use(require('markdown-it-replace-link'))

I am new to node.js. Based on my reading, I think this code still needs a Makefile that runs browserify, and puts the browser-friendly version into ./dist/. Is that correct?

I've looked at other browser-friendly markdown-it plugins and that seems to be what they have done. They export a variable, for example, window.markdownitLinkifyImages, that can be used in the browser instead of require('markdown-it-replace-link').

Would it be possible to provide a browser-friendly version? If not, I would be happy to contribute a Pull Request, if this is the correct approach.

Thanks!

Support embedded HTML

Does this support embedded HTML like this:

[Hello](test)

<a href="test2">Hello2</a>

to:

<p><a href="http://me.com/test">Hello</a></p>

<a href="http://me.com/test2">Hello2</a>

Fail to parse `<center>![](~/35)`

I found it unable to parse <center>![](~/35)

Question: Is it possible to read the frontmatter of the file?

I'm wanting to change the links to use the permalink attribute from the frontmatter.

Is there a way I can read the frontmatter from within 'replaceLink' ?