Welcome to GitBook Integration Platform!
This repository contains code, packages, and scripts related to the integrations platform in GitBook. Want to get started building your first integration? Head to our documentation to get started.
Visit our documentation to learn how to use the GitBook Integration Platform with our API reference, getting started guides, and more.
The documentation is hosted on GitBook and lives in this repository, within
/docs.
See a mistake or would like to help us with our documentation? Feel free to follow our contributing guide to open a pull request!
Packages are the core of our integration platform, containing the code for the following:
@gitbook/cli: CLI to build and publish integrations for GitBook@gitbook/api: API client for GitBook@gitbook/runtime: Core library to easily write integrations
It also hosts the default integrations provided by the GitBook team, organized by category:
| Integration | Description |
|---|---|
| Ahrefs | Receive GitBook traffic insights directly in your Ahrefs dashboard. |
| Amplitude | Track and identify GitBook page visitors with Amplitude analytics. |
| DevTune AI Traffic | Track AI bot crawlers and LLM referral traffic to your documentation. |
| Fathom | Receive GitBook traffic insights directly in your Fathom dashboard. |
| Fullstory | Capture user sessions in GitBook with Fullstory to understand reader behavior. |
| Google Analytics | Receive GitBook traffic insights directly in your Google Analytics dashboard. |
| Heap | Plug your GitBook site to your Heap Analytics instance. |
| Hotjar | Plug your GitBook site to your Hotjar installation. |
| Koala | Receive GitBook traffic insights directly in your Koala dashboard. |
| Mixpanel | Plug your GitBook site to your Mixpanel account. |
| Pendo | Plug your GitBook site to your Pendo Analytics instance. |
| Piwik PRO Analytics | Inject Piwik PRO Tag Manager into your published GitBook documentation site. |
| Plausible | Receive GitBook traffic insights directly in your Plausible dashboard. |
| PostHog | Plug your GitBook site to your PostHog installation. |
| Reo.dev | Plug your GitBook site to your Reo.dev installation. |
| SalesViewer | Track and identify GitBook page visitors with SalesViewer analytics. |
| Segment | Integrate your GitBook public documentation with your Segment pipeline. |
| Toucan Toco | Embed Toucan's customer-facing analytics in your GitBook content. |
| Unify | Receive GitBook traffic insights directly in your Unify dashboard. |
| Wistia | Add Wistia video analytics to your GitBook site. |
| ZoomInfo | Plug your GitBook site to your ZoomInfo instance. |
| Integration | Description |
|---|---|
| Crisp | Add the Crisp chat widget to your published GitBook content. |
| Freshdesk | Add the Freshdesk chat widget to your published GitBook content. |
| Front | Add the Front chat widget to your published GitBook content. |
| HelpScout | Add the HelpScout chat widget to your published GitBook content. |
| Intercom | Add the Intercom chat widget to your published GitBook content. |
| RunLLM | Add the RunLLM AI chat widget to your doc site. |
| Salesforce Service Cloud Chat | Add Salesforce Service Cloud Chat to your published GitBook content. |
| Integration | Description |
|---|---|
| Reflag | Sync your GitBook site's schema with Reflag to deliver adaptive experiences to users. |
| Formspree | Collect user signups directly in your published GitBook sites. |
| HubSpot | Add the HubSpot tracking code to your published GitBook site. |
| Launchdarkly | Sync your GitBook site's schema with LaunchDarkly to deliver adaptive experiences to users. |
| Mailchimp | Grow your Mailchimp audiences, directly from your GitBook content. |
| Marketo | Use Marketo's automation platform (part of the Adobe Experience Cloud) with your GitBook docs. |
| Integration | Description |
|---|---|
| AWS Cognito | Control who has access to your published documentation with AWS Cognito. |
| OIDC | Control who has access to your published documentation with your authentication provider. |
| Auth0 | Control who has access to your published documentation with Auth0. |
| Azure | Control who has access to your published documentation with Azure. |
| Okta | Control who has access to your published documentation with Okta. |
| Integration | Description |
|---|---|
| Arcade | Embed interactive product demos in your documentation. |
| Figma | Embed Figma files and designs directly into GitBook pages. |
| GitHub Files | View GitHub files or permalinks into code blocks. |
| GitLab Files | View GitLab files or permalinks into code blocks. |
| Jira | Embed Jira issues directly in your GitBook documentation. |
| Linear | Embed Linear issues directly in your GitBook documentation. |
| Lucid | Embed Lucid projects directly into GitBook. |
| Mermaid | Build diagrams and visualizations using Markdown-inspired text definitions and code. |
| PlantUML | Build diagrams and visualizations using PlantUML. |
| RunKit | Embed interactive Node.js notebooks in your GitBook documentation. |
| Sentry | Embed Sentry issues in your GitBook documentation. |
| Integration | Description |
|---|---|
| GitHub Sync | Synchronize your GitBook content with GitHub with GitBook's bi-directional integration. |
| GitLab Sync | Synchronize your GitBook content with GitLab with GitBook's bi-directional integration. |
| Integration | Description |
|---|---|
| Discord | Notify a server channel in Discord with real-time events from GitBook. |
| GitHub Copilot | GitBook Copilot uses your documentation to provide instant answers in your workflow. |
| Slack | Ask questions and get answers to your documentation, right in Slack. |
| Webhook | Send GitBook events to your webhook endpoints. |
| Integration | Description |
|---|---|
| OneTrust Cookie Consent | Add the OneTrust cookie consent banner to your published GitBook site. |
Whether you're interested in contributing your own integration, helping out with our docs, or making updates to our packages—start by heading to our contributing guide.
Looking for something else? Head to our developer docs or try asking GitBook Assistant.
Still stuck? Send our support team a message.
