The State of Docs Report 2025 is live! Dive in and see why docs matter more than ever:
Read the report
LogoLogo
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Help Center
  • Getting Started
    • GitBook Documentation
    • Quickstart
    • Importing content
    • GitHub & GitLab Sync
      • Enabling GitHub Sync
      • Enabling GitLab Sync
      • Content configuration
      • GitHub pull request preview
      • Commit messages & Autolink
      • Monorepos
      • Troubleshooting
  • Creating Content
    • Formatting your content
      • Inline content
      • Markdown
    • Content structure
      • Spaces
      • Pages
      • Collections
    • Blocks
      • Paragraphs
      • Headings
      • Unordered lists
      • Ordered lists
      • Task lists
      • Hints
      • Quotes
      • Code blocks
      • Files
      • Images
      • Embedded URLs
      • Tables
      • Cards
      • Tabs
      • Expandable
      • Stepper
      • Drawings
      • Math & TeX
      • Page links
    • Reusable content
    • Broken links
    • Searching content
      • Search & Quick find
      • GitBook AI
    • Writing with GitBook AI
    • Version control
  • API References
    • OpenAPI
      • Add an OpenAPI specification
      • Insert API reference in your docs
    • Guides
      • Structuring your API reference
      • Adding custom code samples
      • Managing API operations
      • Describing enums
      • Integrating with CI/CD
  • Extensions reference
  • Publishing Documentation
    • Publish a docs site
      • Public publishing
      • Private publishing with share links
    • Site structure
      • Content variants
      • Site sections
    • Site customization
      • Icons, colors, and themes
      • Layout and structure
      • Extra configuration
    • Set a custom domain
    • Setting a custom subdirectory
      • Configuring a subdirectory with Cloudflare
      • Configuring a subdirectory with Vercel
    • Site settings
    • Site insights
    • Site redirects
    • Visitor authentication
      • Enabling visitor authentication
      • Setting up Auth0
      • Setting up Azure AD
      • Setting up AWS Cognito
      • Setting up Okta
      • Setting up OIDC
      • Setting up a custom backend
  • LLM-ready docs
  • Collaboration
    • Live edits
    • Change requests
    • PDF export
    • Inviting your team
    • Comments
    • Notifications
  • Integrations
    • Install and manage integrations
    • GitHub Copilot
  • Account management
    • Plans
      • Legacy pricing
      • Sponsored site plan
      • Non-profit plan
      • Billing policy
    • Subscription cancellations
    • Personal settings
    • Organization settings
    • Member management
      • Invite or remove members
      • Roles
      • Teams
      • Permissions and inheritance
    • SSO & SAML
      • SSO Members vs non-SSO
  • Resources
    • GitBook UI
    • Keyboard shortcuts
    • Glossary
Powered by GitBook
LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
On this page
  • General
  • Audience
  • Domains & Redirects
  • Features
  • Site structure
  • Ads and sponsorship

Was this helpful?

Edit on GitHub
  1. Publishing Documentation

Site settings

Customize and edit settings across your published site

Last updated 1 month ago

Was this helpful?

General

Site title

Change the name of your site, if you don't have a custom logo this is the name that your site visitors will see.

Social preview

Here, you can upload a custom social preview image for your site. This will set the site’s og:image to your uploaded image, and it’ll show when the site’s link is shared to any platform or product that supports OpenGraph images, such as Slack or X.

If you don’t add a social preview, GitBook will automatically generate one using your theme color, page title and description.

Unpublish site

Unpublish your site, but keep its settings and customizations. You can publish your site again at any time.

Delete site

Unpublish and remove your site from the Docs site section in the GitBook app.

Audience

Audience

Choose who sees your published content. See Publish a docs site for more info.

Adaptive content Premium & Ultimate

Turn on adaptive content for your site pages, variants, and sections.

Your visitor token signing key will also be displayed here.

See Adaptive content for more info.

Domains & Redirects

Custom domain

Configure a custom domain to unify your site with your own branding. See Set a custom domain for more info.

GitBook URL

Customize the slug of your docs site (e.g. organization.gitbook.io/custom-slug)

Features

AI search Premium & Ultimate

Let your site visitors ask GitBook anything with AI. See GitBook AI for more info.

PDF export Premium & Ultimate

Let your visitors to export your GitBook as PDF. See PDF export for more info.

Page ratings Premium & Ultimate

Choose whether or not visitors to your published content can leave a rating on each page to let you know how they feel about it. They’ll be able to choose a sad, neutral, or happy face.

Site structure

Ads and sponsorship

If your site has multiple , you can use the drop-down menu in this modal to add a custom social preview image for each one, or for your entire site.

Note: Deleting a site is a permanent action and cannot be undone. Any settings and customizations will be lost, but your content will remain in its .

You can review the results of these ratings by opening the section of your docs site dashboard and selecting the tab.

site sections
space
Site redirects
Site structure
Sponsored site plan
Insights
Content scores
Update the settings for your published documentation.

Certain customization features are only available on .

Premium and Ultimate site plans