Links

Overview

Build context-relevant, action-orientated integrations directly on top of GitBook.
The GitBook Integration Platform is currently in alpha. This means you should not rely on it's availability, and that it may change without prior warning.
This section describes how to create integrations and custom blocks in GitBook—Whether you're publicly integrating your service with ours, or you're building for your own team's private usage.
Developing custom blocks for GitBook is built using TypeScript, making it easier to spot errors in your code earlier on.

Build your first integration

In order to build your first integration, you'll need to run the GitBook CLI to bootstrap your project.

CLI Quickstart

After bootstrapping your project, check out the rest of the documentation to learn more about how Integrations and Custom Blocks work inside of GitBook.

Runtime

View the APIs available at runtime

ContentKit

Learn how blocks interact with GitBook
Reference
View the complete reference for building Custom Blocks

Blocks

Learn how to handle link unfurling
Learn how to work with editable blocks