remark-add-query-param

A remark plugin to add query parameters to links

Bug report · Feature request

Why? 🤔

I use markdown to write my blog posts and I wanted to add query parameters to all the links in my blog posts. I couldn't find any plugin that does this so I decided to write one myself. This plugin adds query parameters to all the links in the markdown file.

So if you have a markdown file like this:

This is a [link](https://example.com)

And you use this plugin with the query parameter utm_source=remark-add-query-param, the output will be:

This is a [link](https://example.com?utm_source=remark-add-query-param)

Usage 💻

First you need to install the package using npm or yarn or pnpm.

npm install remark-add-query-param

Then you can use it in your remark pipeline like this:

const remark = require('remark');
const addQueryParam = require('remark-add-query-param');

const processor = remark().use(addQueryParam, {
  queryParam: 'utm_source=remark-add-query-param',
});

processor.process('This is a [link](https://example.com)'); // This is a [link](https://example.com?utm_source=remark-add-query-param)

Configurations ⚙️

You can pass the following options to the plugin:

• queryParam: The query parameter to add to the links. This is required and should be a valid query parameter string i.e key=value.
• externalLinks: If set to false, the plugin will not add the query parameter to external links. Default is true i.e it will add the query parameter to all external links.
• internalLinks: If set to false, the plugin will not add the query parameter to internal links. Default is true i.e it will add the query parameter to all internal links.

Contributing 🫱🏻‍🫲🏼

Follow the contribution guidelines to contribute to this project.

Bugs or Requests 🐛

If you encounter any problems feel free to open an issue. If you feel the project is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull requests are also welcome.

Where to find me? 👀