1. Choose a subdomain and its location

Here are some examples of domains you can set in GitBook.

Domain typeExampleSupported?

Apex domain

example.com

www subdomain

www.example.com

Custom subdomain

docs.example.com

help.example.com anything.example.com

Decide where to set the custom domain

There are two levels at which a custom domain can be set:

  1. At the organization level

  2. At the docs site level

Your URL path will depend on where you set the domain.

Organization custom domains

Because organizations can contain many sites (and internal spaces) any custom domain set for the organization will apply to all published sites unless overridden.

Each published site will follow after your organization's domain

Org-domain/site-name/page-group/page

If you’ve decided that you want to set a custom domain at the organization level, you can go to the next step for details on how to set it. If you’re not sure, keep reading to review your other options.

Site custom domains

If you want to set up a domain different from your main organization domain, or you want to maintain a shorter URL path, you should set the domain directly at a site level.

For example, the domains set for Site A and Site B could be:

  • site-a-domain/page-group/page

  • site-b-domain/page-group/page

Domains set at a site level will have the following path

If no page groups are used: site-domain/page

(Or, if page groups are used:site-domain/page-group/page)

If you’ve decided that you want to set a custom domain at the organization level, you can go to the next step for details on how to set it. If you’re not sure, keep reading to review your other options.

Last updated