https://github.com/gitbookio/integrations
Toolkit to build integrations on GitBook
https://github.com/gitbookio/integrations
documentation integrations open-source react typescript
Last synced: 8 months ago
JSON representation
Toolkit to build integrations on GitBook
- Host: GitHub
- URL: https://github.com/gitbookio/integrations
- Owner: GitbookIO
- Created: 2022-06-03T09:25:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T19:08:07.000Z (8 months ago)
- Last Synced: 2025-05-07T20:03:54.659Z (8 months ago)
- Topics: documentation, integrations, open-source, react, typescript
- Language: TypeScript
- Homepage:
- Size: 126 MB
- Stars: 97
- Watchers: 12
- Forks: 64
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
Awesome Lists containing this project
README
# 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](https://developer.gitbook.com/getting-started/setup-guide) to get started.
## Documentation
Visit our [documentation](https://developer.gitbook.com/) 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`](./docs).
See a mistake or would like to help us with our documentation? Feel free to follow our [contributing guide](./.github/CONTRIBUTING.md) to open a pull request!
## Packages
Packages are the core of our integration platform, containing the code for the following:
- [`@gitbook/cli`](./packages/cli/): CLI to build and publish integrations for GitBook
- [`@gitbook/api`](./packages/api/): API client for GitBook
- [`@gitbook/runtime`](./packages/runtime/): Core library to easily write integrations
## Integrations
It also hosts the default integrations provided by the GitBook team:
- [`arcade`](./integrations/arcade/)
- [`fathom`](./integrations/fathom/)
- [`figma`](./integrations/figma/)
- [`formspree`](./integrations/formspree/)
- [`github-files`](./integrations/github/)
- [`gitlab-files`](./integrations/gitlab/)
- [`googleanalytics`](./integrations/googleanalytics/)
- [`heap`](./integrations/heap/)
- [`hotjar`](./integrations/hotjar/)
- [`intercom`](./integrations/intercom/)
- [`jira`](./integrations/jira/)
- [`linear`](./integrations/linear/)
- [`mailchimp`](./integrations/mailchimp/)
- [`mermaid`](./integrations/mermaid/)
- [`plausible`](./integrations/plausible/)
- [`runkit`](./integrations/runkit/)
- [`sentry`](./integrations/sentry/)
- [`segment`](./integrations/segment/)
- [`slack`](./integrations/slack/)
- [`toucantoco`](./integrations/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](./.github/CONTRIBUTING.md).
## Resources
- [GitBook Integrations Homepage](https://www.gitbook.com/integrations)
- [GitBook Integrations Docs](https://developer.gitbook.com/)