website logo
😀Docs
SDK API
Navigate through spaces
😀Docs
SDK API
⌘K
👋Welcome to Highlight
Getting Started
Client SDK
Backend SDK
Tips
Performance Impact
Upgrading Highlight
Local Development
Troubleshooting
Monkey Patches
Proxying Highlight
Session Search Deep Linking
Content-Security-Policy
Session Replay
Privacy
Recording Network Requests and Responses
Identifying Users
Tracking Events
Versioning Sessions
Rage Clicks
Network DevTools
Session Sharing
Live Mode
Console Messages
Session Shortcut
HTML iframe Recording
Error Monitoring
Sourcemaps
Versioning Errors
Grouping Errors
Product Features
Canvas
Environments
Team Management
Keyboard Shortcuts
Analytics
Segments
User Feedback
Web Vitals
Comments
Alerts
WebGL
Performance Data
Session Search
Frontend Observability
On-Premises
Deployment Overview
Frequently Asked Questions
Integrations
Intercom Integration
Sentry Integration
Slack Integration
React.js Integration
Amplitude Integration
Mixpanel Integration
Segment Integration
Linear Integration
Front Plugin
Electron Integration
Clearbit Integration
Docs powered by archbee 
4min

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.

npm
yarn
|

Register Highlight as a Gatsby Plugin

You will need to register the Highlight Gatsby Plugin.

JS
|

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.



Updated 18 Aug 2022
Did this page help you?
Yes
No
UP NEXT
SvelteKit
Docs powered by archbee 
Updated 18 Aug 2022
Did this page help you?
Yes
No
UP NEXT
SvelteKit
Docs powered by archbee 
TABLE OF CONTENTS
👋 Welcome!
Installing the SDK
Register Highlight as a Gatsby Plugin
Verify