Overview

Build context-relevant, action-orientated integrations directly on top of GitBook.

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

pageQuickstart

After bootstrapping your project, head to the Development section to learn about developing your app in GitBook.

Runtime

Runtime APIs

View the APIs and methods available at runtime

Environment

Learn more about the environment your integration runs in

HTTP Fetch

Learn about fetching data inside your app or components

Receiving Requests

Learn about how to recieve requests in your app or components

ContentKit

Interactivity

Learn how blocks interact with GitBook

Reference

View the complete reference for building Custom Blocks

Blocks

Link unfurling

Learn how to handle link unfurling

Editable blocks

Learn how to work with editable blocks

Working with Markdown