API Reference
Error Monitoring
Getting Started
Welcome to Highlight
Integrations
Product Features
Session Replay
Tips
Menu

Gatsby.js

👋 Welcome!

Let's get you up and running with Highlight. We should be done in less than 2 minutes.

Installing the SDK

Install @highlight-run/gatsby-plugin-highlight using your package manager.

# with npm npm install @highlight-run/gatsby-plugin-highlight # with yarn yarn add @highlight-run/gatsby-plugin-highlight
Copy
Register Highlight as a Gatsby Plugin

You will need to register the Highlight Gatsby Plugin.

module.exports = { plugins: [ { resolve: '@highlight-run/gatsby-plugin-highlight', options: { orgID: '<YOUR_PROJECT_ID>', // Get your project ID from https://app.highlight.run/setup }, }, ], }
Copy
Verify

Start your app, go to it in the browser, then click around. Highlight will be recording your session and it will show up on https://app.highlight.run/sessions a few seconds after recording has started.