Jekyll

Get Your Tracking Script

First, you'll need your AddonPulse tracking script. You can find this in your AddonPulse dashboard under Site Settings > Tracking Code. It will look something like this:

<script async defer src="https://app.addonpulse.com/api/script.js" data-site-id="YOUR_SITE_ID"></script>

Replace YOUR_SITE_ID with your actual Site ID from your AddonPulse dashboard.

Locate your main layout file

In your Jekyll project, find your main layout file. This is often _layouts/default.html.

Add the tracking script

Open this file and paste the AddonPulse tracking script just before the closing </body> tag.

{{ site.title }}
{{ content }}
<!-- Other footer content -->

<!-- AddonPulse Analytics Script -->
{% raw %}
{% if jekyll.environment == "production" %}
  <script async defer src="https://app.addonpulse.com/api/script.js" data-site-id="YOUR_SITE_ID"></script>
{% endif %}
{% endraw %}

</body>
</html>

Explanation:

• {% raw %}{% if jekyll.environment == "production" %}{% endraw %}: This Liquid tag condition ensures the script is only included when your site is built for production (e.g., when JEKYLL_ENV=production jekyll build). This prevents tracking your local development views.
• Replace YOUR_SITE_ID with your actual Site ID. The script source https://app.addonpulse.com/api/script.js is for the standard AddonPulse instance.

Create the Include File

• In your Jekyll project, navigate to the _includes/ directory. If it doesn't exist, create it.
• Create a new file named addonpulse-analytics.html (or similar) inside _includes/.
• Paste the following into _includes/addonpulse-analytics.html:

{% raw %}
{% comment %} _includes/addonpulse-analytics.html {% endcomment %}
{% if jekyll.environment == "production" and site.addonpulse_site_id %}
  <script async defer src="{{ site.addonpulse_instance_url | default: 'https://app.addonpulse.com' }}/api/script.js" data-site-id="{{ site.addonpulse_site_id }}"></script>
{% endif %}
{% endraw %}

Include in Layout

• Open your main layout file (e.g., _layouts/default.html).
• Just before the closing </body> tag, add:

{{ site.title }}
{{ content }}
<!-- Other footer content -->

{% raw %}{% include addonpulse-analytics.html %}{% endraw %}

</body>
</html>

Configure _config.yml

• Open your _config.yml file and add your AddonPulse details:

# AddonPulse Analytics Configuration
addonpulse_instance_url: "https://app.addonpulse.com" # Optional, defaults in include
addonpulse_site_id: "YOUR_SITE_ID"

This method keeps your credentials in the configuration file and makes the script inclusion conditional on addonpulse_site_id being set.

Build your Jekyll site

Build your Jekyll site. For production, set the JEKYLL_ENV environment variable:

JEKYLL_ENV=production jekyll build

Or, if you use GitHub Pages, it typically sets jekyll.environment to production automatically during its build process.

Deploy

Deploy the generated _site/ directory to your web server.

Verify Integration

• Open your live Jekyll website in a browser.
• Navigate through a few pages.
• Check your AddonPulse dashboard for incoming data. It might take a few minutes for the first events to appear.