How to create branded documentation

Make your docs match your brand with a custom domain, logo, color scheme and more

Adding your brand’s identity to documentation is a great way to make your docs site feel like part of your product. And GitBook has plenty of tools to help you do just that.

Here’s how to utilize a few of them to build a docs site that looks great and fits with your brand.

Creating customized docs that match your brand is easy with GitBook.

Set a custom domain for your docs

You can add a custom domain to your site to make it part of your brand property online.

1

Open site settings

Navigate to your docs site in GitBook, then click Settings in the top-right corner.

2

Add a custom domain

Choose the Domain and redirects tab. Here, you’ll see an option to set up a custom domain. Click it and it'll start the process.

Set up a custom domain.
3

Follow the setup process

The menu will guide you through the setup process — if you need help, our documentation will walk you through the entire process.

Set up your documentation to match your brand by customizing colors, uploading a logo, adding links to your site and much more. Here are a few options to try:

You can add your company logo to your site — it will sit in the top-left of your site, replacing the site title and icon.

To do this, head to your site dashboard and click Customization in the top bar. In the General tab you’ll see the option to add a custom logo — click the image preview to upload an image for light mode and dark mode.

You can add custom logos for both light and dark mode, so your docs look great however they’re viewed.

Set a theme and choose colors

Under the same customization panel, scroll down to the Themes section. Here, you’ll find settings for changing your site’s colors to match your brand:

You can set a theme and choose color options from the Themes section — including the Custom theme, which offers more control.

The first three options let you set a primary color only. Select the Custom theme and you’ll also be able to set specific colors for Header links and Header background, giving you extra control.

Make sure to check your dark mode colors here too, so you can be sure you docs look great in either mode.

Change your font and icon style

We have a number of font options you can choose from under the Styling section of the General tab. Choose from the drop-down.

In your GitBook space, you can also add an icon to each page of your documentation, to add some visual flair and signpost to your readers what you page is about. In your site’s Customization menu, you can then tweak the icons’ style using the Icons menu. You can make them solid, duotone and more — the choice is yours!

Change your font and icon styles in the Styling section.

Want to add some links to other places — such as your product, a sign-up page or an external source? In the Layout tab you can add header links and buttons that will appear at the top of your page, and a footer with a logo, copyright notice and other links, such as a to terms of service page.

You can nest header links if you want to create a drop-down menu in your header, or assign primary and secondary button styling if you want a link to be more prominent.

In the Layout tab, you can add links and buttons to your header, and create a footer with your company logo, copyright information, and links.

→ Get started with GitBook for free

→ Read more about customization in our docs

→ The complete guide to publishing documentation in GitBook

Last updated

Was this helpful?