Site customization

You can customize the appearance of your published documentation, match the user interface to the language of your content, and more. You can apply customizations to your entire docs site as a site-wide theme, or to individual variants and site sections.

​

Customizing sites with multiple sections or variants

If you have a docs site with multiple sections or variants, you can control the customization of each one individually. Select the whole site or a specific site section using the drop-down menu at the top of the Customization panel.

• Site-wide settings – These automatically apply to all linked spaces
• Section or variant specific settings – If you’re using site sections or variants, you can set specific customization that will override the default site-wide setting

​

Title, icon and logo

​

Title

You can set any title you choose for your space. Note: this setting will only affect the title that displays in the published documentation. If you want to edit the title in the GitBook app, close the customize menu and edit it at the top of the space.

​

Icon

You can set an emoji, or upload an icon of your own. The icon you set in the Customization menu will be used as the favicon for your docs site.

​

Custom logo

You can replace both the published space’s title and icon with a custom logo so that your documentation better reflects your own branding — and you can upload two versions: one for light mode, and one for dark mode.

​

Themes

Themes let you customize the color scheme of your published content for both light and dark mode. There are four themes to choose from:

​

Clean

A modern theme featuring translucency and minimally styled elements. Your primary color (or tint) affects links and other highlighted interface elements. Available for all sites and is the default theme.

​

Muted

A sophisticated theme with decreased contrast between elements. The site background is more pronounced and blends in with the foreground, and some elements feature an inverted look. Available for all sites.

​

Bold

A high-impact theme with prominent colors and strong contrasts. Your primary color (or tint) will be used for the header of the site, and other highlighted elements like icons are colored along with it.

​

Gradient

A trendsetting theme featuring a gradient background and splashes of color. The gradient and highlighted elements will be colored by your primary color (or tint).

​

Colors

​

Primary color

Your site’s primary color will affect the styling of highlighted interface items and navigational elements like links, the current page and section, breadcrumbs, and primary header buttons. GitBook automatically adjusts colors on individual elements for readability if the contrast with the background is too low or when a visitor’s system requests higher contrast.

​

Tint color

Your site’s tint color will subtly change the color of all text and icons across your entire site — including header links, icon color, and UI elements like the Ask or search bar. The tint color will not affect navigational elements like links and buttons, which always use the primary color.

​

Semantic colors

Semantic colors are applied to hint blocks within your published content, and can also be applied to code blocks. You can change the background color of each hint style; these changes will be reflected on the published site you’re customizing.

​

Code theme

Code themes change the appearance of code and API blocks in your published documentation. The themes list includes:

• Adaptive themes – These standard light and dark mode themes use your site’s color palette to match your brand
• Shiki themes – Choose from more than 60 theme presets in both light and dark modes

You can choose individual code themes for your docs’ light and dark mode. And you can use any light or dark color scheme in any mode.

​

Site styles

​

Font family

Choose a standard and monospace font family for your published content from a curated list of popular options.

​

Custom fonts

Upload your own standard and monospace fonts to align your published content with your brand’s style guide. To upload a font, click Add custom font and follow the instructions. You must upload a font file for both regular and bold weights. GitBook currently supports .woff and .woff2 formats.

​

Icons

When using page icons, set the weight and style of the displayed icons here.

​

Corner style

Choose either rounded or straight corners to match your brand’s style preferences.

​

Depth style

Choose between two depth styles, which apply to cards, buttons and any other element with a shadow:

• Subtle: Some shadows and elevation
• Flat: No shadows or elevation

​

Link style

Choose between two link designs:

• Default: highlights the entire link in your primary or tint color
• Accent: adds a colored underline to the link, leaving the text color unchanged

​

Layout and structure

​

Header

Search bar Change the position and look of the search bar between prominent (centered in the header) and subtle (located in the upper right corner). Turning off the header entirely will place the search bar in the sidebar instead. Navigation Add header links to your site. You could use header links to point to important parts of your documentation, or link back to your main website. You can choose what appearance you would like your link to have—normal link, primary button, or secondary button.

​

Announcement

Toggle this option on to add an announcement banner to the top of your published site. You can add a message and optionally include a link and call to action, which will appear after your message in the banner.

​

Footer

Add your logo or another image in the footer, copyright information, and organize links into multiple sections.

​

Social accounts

You can add social accounts to your site’s metadata and footer from the Sharing tab in the customization menu. Click + Add account and choose an account type from the list of included options — such as X, GitHub, LinkedIn, Discord and Bluesky.

​

Social preview

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.

​

Extra configuration

​

Localize user interface

You can select from a list of languages to localize the user interface of your published content. This applies translations to the non-custom areas of the interface.

​

Primary link

In the Primary link section, you can set a custom URL for the logo in the top-left corner of your docs site. By default, clicking the logo or site title will lead users back to the first page of your docs site.

​

External links

Controls the behavior when your site users click a link to an external URL. By default, these links will open in the same tab, but you can switch this to open in a new tab.

​

Page actions

Page actions adds a page-level dropdown to every page of your docs, allowing users to perform quick actions on a page’s content — ideal for using your docs content as context within an AI prompt. Available actions include:

• Open in AI providers (ChatGPT, Claude)
• Copy/View as Markdown
• Edit on GitHub/GitLab
• Export PDF

​

Privacy policy

You can link to your own privacy policy to help visitors understand how your GitBook content uses cookies and how you protect their privacy.