hexo-tag-convertkit

hexo-tag-convertkit

A small plugin that integrates Hexo blog with a Convertkit email marketing platform.

Why to use this plugin?

Convertkit counts visitors to calculate the conversion rate of your newsletter form. However, it counts all visitors that visits the page with a form, no matter if the visitor seen it. This plugin uses JavaScript to load Convertkit form only when the visitor scrolls to the place on your website where the newsletter form is displayed. This way you can get much more accurate information about the conversion rate.

Installation

npm install --save hexo-tag-convertkit

Configuration

The plugin requires one field to be configured - the domain. Convertkit serves the JavaScript file from the dedicated subdomain that hosts your unique index.js file. Below is a configuration block you need to add to the _config.yml file.

convertkit:
  domain: your-domain.ck.page

Example: if your unique index.js file is hosted on https://15a5-my-domain.ck.page/14aff6777a4e/index.js, use the following configuration:

convertkit:
  domain: 15a5-my-domain.ck.page

Usage

To insert Convertkit form using JavaScript code, use the convertkit(uid) tag. You can find the newsletter form uid on the Embed page. For instance, if your JavaScript form code is the following:

<script async data-uid="123123123" src="https://15a5-my-domain.ck.page/123123123/index.js"></script>

then the uid is 123123123.

EJS

<%= convertkit('123123123') %>

Markdown (blog post body)

{% convertkit '123123123' %}

Configuring offset threshold

The default value for the offset threshold is 1000. You can override it if needed in the _config.yml file.

convertkit:
  threshold: 500