GitBook

GitBook is a popular platform for creating documentation and knowledge bases. You can add AddonPulse Analytics to track how visitors use your documentation.

Custom scripts require a Pro plan or higher and a custom domain configured for your GitBook space.

How to Add AddonPulse to GitBook

Open Space Settings

Navigate to your GitBook space
Click on the Settings icon (gear) in the top right
Go to Integrations in the sidebar

Add Custom Script

Scroll to the Custom scripts section
In the Head section, add the following code:

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

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

Save Changes

Click Save to apply the script to your documentation site.

Requirements

For custom scripts to work on GitBook, you need:

Pro, Team, or Enterprise plan - Custom scripts are not available on the free plan
Custom domain - Scripts only load on custom domains, not on *.gitbook.io URLs

Troubleshooting

Script not appearing

Ensure you have a Pro plan or higher
Verify your custom domain is properly configured
Check that you're viewing the site through your custom domain, not *.gitbook.io

Changes not reflecting

GitBook may cache pages. Try:

Hard refresh (Ctrl+Shift+R or Cmd+Shift+R)
Viewing in an incognito/private window
Waiting a few minutes for cache to update

Tracking internal vs public docs

The tracking script will work for both public documentation and internal/private spaces (when accessed by authenticated users through your custom domain).

On this page