Integrate JavaScript SDK v1.1 with your Jekyll site
4 minute read
This guide will help you integrate RudderStack with your Jekyll site using the RudderStack JavaScript SDK. On successful integration, you can track and send real-time user events to your preferred destinations via RudderStack.
To set up the event stream on your Jekyll site, you need to perform the following steps:
The RudderStack JavaScript source is required track the events from your Jekyll app. Follow these steps to set it up in your RudderStack dashboard:
Note the data plane URL in your RudderStack dashboard. This is required to set up the JavaScript SDK in your Jekyll app.
Click the Sources button in the left navigation bar and select New Source to create a source. Under Sources, select Event Streams > JavaScript.
Assign a name to your source and click Continue.
Your JavaScript source is now configured. Note down the write key for this source:
Installing and configuring the JavaScript SDK in your Jekyll site
Jekyll has an extensive theme system that helps customize your site’s presentation. Minima is Jekyll’s default theme. You can check your default Jekyll theme using the following command:
bundle info --path
The following command opens an explorer window showing the theme files and directories:
open $(bundle info --path)
To integrate RudderStack with your Jekyll site and set up the tracking code, follow the steps below:
Create a rudder.html inside the _includes folder in your Jekyll theme’s folder and include the following script:
<script>rudderanalytics=window.rudderanalytics=[];varmethods=["load","page","track","identify","alias","group","ready","reset","setAnonymousId","getAnonymousId",];for(vari=0;i<methods.length;i++){varmethod=methods[i];rudderanalytics[method]=(function(methodName){returnfunction(){rudderanalytics.push([methodName].concat(Array.prototype.slice.call(arguments)));};})(method);}rudderanalytics.load("WRITE_KEY","DATA_PLANE_URL");rudderanalytics.ready(function(){console.log("Application is ready with JS");});rudderanalytics.track("Simple track call");</script><scriptsrc="https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js"></script>
If you are using an older version of the JavaScript SDK, see the Version Migration Guide to migrate to SDK v1.1.
Replace <WRITE_KEY> and <DATA_PLANE_URL> with your JavaScript source write key and the data plane URL obtained in the Creating a JavaScript source in RudderStack section above.
Go to the _includes/head.html file of your theme folder and run the following command:
This section details the steps required to set up a destination in RudderStack, where you can send all events tracked by the JavaScript SDK you set up above.
In your RudderStack dashboard, click Destinations > New destination.
Choose your preferred destination from the list.
Assign a name to the destination and click Continue.
Select the JavaScript source configured in the above section and click Continue.
Configure the destination with the required settings.
Optionally, you can add a user transformations to this destination to transform your events.
Deploying your Jekyll site and verifying the event stream
To verify if your event stream is working correctly, deploy your Jekyll site and test if the events are tracked and delivered correctly. Follow these steps:
From your terminal, navigate to the folder containing your Jekyll site and run following command:
bundle exec jekyll serve
Open the local server URL(generally http://localhost:4000/) in your browser to view the site.
Go to your browser’s developer tools and check the Network tab to verify if the RudderStack JavaScript SDK (rudder-analytics.js) is loaded correctly. The following image highlights this option for the Google Chrome browser:
Click the various links or pages in your site for RudderStack to track these actions.
Go to the Live Events tab of your JavaScript source in the RudderStack dashboard to check if the events are tracked. Note that you may face a minor delay before the events start showing up in your dashboard.
Go to your destination to verify if the events are received successfully.
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.