Explore how adaptive content transforms your docs into a dynamic, tailored experience for every user.
Read the docs
LogoLogo
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Help Center
  • Getting Started
    • Developer Documentation
    • Quickstart
    • Development
    • Publishing
  • Integrations
    • Introduction
    • Using the CLI
    • Configuration
    • ContentKit
      • Component reference
    • Integration runtime
  • Client library
  • Guides
    • Creating a custom unfurl action
    • Creating interactive blocks
    • Referencing your integration in Markdown
    • Working with HTTP requests
    • Using the CLI in CI/CD
  • GitBook API
    • Introduction
    • Authentication
    • API reference
      • Organizations
        • Organization members
        • Organization invites
        • Organization AI ask
      • Docs sites
        • Site share links
        • Site structure
        • Site auth
        • Site preview
        • Site customization
        • Site spaces
        • Site sections
        • Site section groups
        • Site redirects
        • Site MCP servers
        • Site ads
        • Site users
        • Site insights
        • Site AI ask
      • Collections
        • Collection users
        • Collection teams
      • Spaces
        • Space content
        • Space comments
        • Space embeds
        • Space users
        • Space teams
        • Space integrations
        • Git
      • Change requests
        • Change request content
        • Change request contributors
        • Change request reviewers
        • Change request comments
      • Translations
        • Glossary
      • Integrations
      • URLs
      • OpenAPI
        • OpenAPI spec versions
      • Conversations
      • Custom fonts
      • Subdomains
      • Users
      • Teams
        • Team members
      • SSO
      • Storage
      • Custom hostnames
      • System info
    • Rate limiting
    • Pagination
    • Errors
  • Marketplace
    • Overview
    • Submit your app for review
  • Resources
    • Concepts
    • Changelog
    • ContentKit playground
    • GitHub examples
Powered by GitBook
On this page
Edit on GitHub
  1. Getting Started

Publishing

Publish your apps and integrations publicly or privately.

Last updated 5 months ago

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
CtrlK
  • Publishing to your organization
  • Installing your integration
  • Updating your integration
  • Sharing your integration with others
  • Submitting to GitBook's Integration Marketplace

Was this helpful?

When you're ready to publish your integration, you're able to publish it for use within GitBook.

Publishing to your organization

Publishing your integration will publish it to GitBook using the options defined in your integration’s gitbook-manifest.yaml file.

In order to publish, it's required to have:

  • name

  • title

  • description

  • visibility

  • script

  • scopes

  • and organization

Installing your integration

After successfully publishing your integration, you will be able to find and install your integration via the link returned in your console.

Updating your integration

At any point you can update your integration by running gitbook publish in your integration’s directory.

Sharing your integration with others

If you're interested in sharing or testing your integration with others, you'll need to update the visibility key in your integration's gitbook-manifest.yaml file.

Visibility
Description

private

Default for new integrations. Only members from the organization defined in the integration's manifest will be able to install the integration.

unlisted

Members from any organization can install the integration. The integration will only be available to install via it's shared install link.

public

Members from any organization can install the integration. Integrations wanting to submit to the marketplace must use this visibility.

Submitting to GitBook's Integration Marketplace

In order for your integration to be listed on our Marketplace, you will need to go through our submission process.

See submitting your app for review for more info.