What is integrations?

The GitBook Integration Platform is a toolkit that lets developers extend GitBook, a popular documentation-hosting platform, by connecting it to other software services. Instead of using GitBook in isolation, you can wire it up to tools like Jira, Slack, Google Analytics, Figma, or GitHub, so your docs can pull in data from those services or push data to them. At a high level, the project is a monorepository (a single repository holding multiple related projects) built in TypeScript. It includes three core packages that work together: a command-line tool (CLI) for building and publishing integrations, an API client that handles communication with the GitBook platform, and a runtime library that provides the building blocks for writing integration logic. On top of those, it also contains the source code for dozens of pre-built integrations maintained by the GitBook team, covering analytics, embedding visual content, issue tracking, and more. The primary audience is developers building custom integrations for GitBook, whether for their own team or to publish more broadly. A practical example: if your company uses Linear for project management, you could use this toolkit to create an integration that embeds live Linear issue statuses directly inside your documentation pages. The included default integrations (like Slack, Figma, and Segment) also serve as reference implementations, you can look at their source to understand how a finished integration is structured. The README is sparse on technical detail, directing readers to external documentation for setup guides and API reference. What's notable is that the default integrations live in the same repo as the platform itself, which makes the project both a tool and a showcase: you can study real, maintained integrations while building your own.