Development
Learn how to develop apps and integrations for GitBook
Developing an integration in GitBook may include using ContentKit and GitBook's Runtime APIs. If you're building an integration that uses GitBook's REST API, you'll already be able to see these updates in realtime.
After bootstrapping your app or integration with the GitBook CLI, you're able to use a different command from the CLI to connect your app with a specific space in your GitBook instance for development purposes.
Before you're able to develop your app, you will first need to publish your app to GitBook's integration platform.
You can do this by running the following command in the root directory of your app:
gitbook publish
By default (defined in the CLI-generated
gitbook-manifest.yaml, your integration will be published privately, and owned by the organization specified in the manifest.After publishing your integration, the CLI will give you a link to install your integration into 1 or more spaces in your organization.
You need to install your app into at least 1 space in order to continue developing it locally. Make sure to note the
spaceId of the space you're installing it into for step 2.While inside the root directory of your app, you can run:
gitbook dev <spaceId>
This will start a development server tied to the space specified in the command. You can find more information on Space ID's and where to find them in the Concepts section.
Running this command will start a development server for use by the integration only. You do not need to navigate to the port the server is running on.
Instead, all integration traffic to the specified space will automatically be served from your local server.
Running this command will generate a
gitbook-dev.yaml file that contains the spaceId needed to establish the connection while you continue to develop your app.After successfully starting the development server, you can add your integration to a page in your development GitBook space.
In a page within the space you connected your development server to, you should be able to insert your integration from the integrations panel, or from the quick insert menu (⌘ + /).
It's recommended that you disable browser caching for the most optimal experience when developing your app.
If you don't see your integration in this list, you may not have published it correctly, or are viewing an incorrect space for your integration.
Any logs sent to the console or made through your integration's
RuntimeContext will be surfaced in your browser's console. Any UI changes made to your integration will need a browser refresh in order to be visible.
We've enabled developer logs in your browser's console, allowing you to debug your integration for any errors in your code.
We're actively aiming to make the development and debugging experience better, and if you have any suggestions or feedback, feel free to start the discussion with us in our GitBook community.
Last modified 3mo ago