Skip to content

Latest commit

 

History

History
 
 

integrations

Folders and files

NameName
Last commit message
Last commit date

parent directory

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

Overview

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

{% content-ref url="../cli/quickstart.md" %} quickstart.md {% endcontent-ref %}

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

Runtime

Runtime APIsView the APIs and methods available at runtime
EnvironmentLearn more about the environment your integration runs in
HTTP FetchLearn about fetching data inside your app or components
Receiving RequestsLearn about how to recieve requests in your app or components

ContentKit

InteractivityLearn how blocks interact with GitBook
ReferenceView the complete reference for building Custom Blocks

Blocks

Link unfurlingLearn how to handle link unfurling
Editable blocksLearn how to work with editable blocks
Working with Markdown