README.md

GitBook Integration Platform

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.

Documentation

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

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

Integrations

It also hosts the default integrations provided by the GitBook team:

• arcade
• fathom
• figma
• formspree
• github-files
• gitlab-files
• googleanalytics
• heap
• hotjar
• intercom
• jira
• linear
• mailchimp
• mermaid
• plausible
• runkit
• sentry
• segment
• slack
• toucantoco

Contributing

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.

Resources

• GitBook Integrations Homepage
• GitBook Integrations Docs