Navigation

Learn about the UI and how to navigate pages in GitBook.

GitBook is split into different sections to make it easier to organize and manage the content you create. Read on to learn more about these sections, and how they help you build an organized and easily searchable content structure.

The sidebar

The GitBook sidebar holds all of your documentation, as well as notifications, the search bar, snippets and more.

The sidebar allows you to see and overview of your GitBook organization at a glance. The sidebar contains:

• Organization switcher If you’re a part of multiple organizations, you can see and switch between them here. You can also create a new organization from this menu.

• Notifications When you’re tagged in a comment or conversation, or when there is important activity in a space you’re working in, you’ll get a notification to show you what’s new.

• Ask or search Powered by GitBook AI, you can ask questions in natural language, or search through the different spaces and content in your organization.

• Home The Home page allows you to see everything your team is working on at a glance. View open change requests, discussions and comments, recent page edits and more.

• Docs sites home Click this to visit the overview page for all the docs sites you have created in your organization.

• Snippets With snippets, you can capture complex information from third-party tools. GitBook AI extracts that valuable knowledge within, and documents it for you in seconds.

• Integrations GitBook integrations supercharge your content, allowing you to embed more into your pages, or add information to your knowledge base from other apps. Head to the integration listing page to see all the available integrations.

• Docs sites Toggle this section to view all the docs sites in your organization right in the sidebar and jump to one with a click.

• Spaces The spaces section is where you’ll find the collections and spaces you create when adding more content. Head to our content structure section to find out more.

• Settings You’ll find personal settings and organization settings at the bottom of the sidebar. Here, you can also toggle light/dark mode, or get help from our support team if needed.

• Trash Deleted spaces appear in the trash. You can restore them for up to seven days — after that, they’re permanently deleted.

Table of contents

The table of contents lists all the pages and links in your selected space.

The table of contents is a list of pages, links, and groups that make up a space. You’ll find it to the right of the sidebar. It’s specific to the space you’re currently viewing.

From the table of contents you can:

• create new pages and subpages

• create page groups

• add external links

• import external docs like websites or Markdown files

• access the Actions menu for individual pages.

If you want to give more focus to the content of your page, you can temporarily hide the table of contents by hovering your cursor next to it and clicking the Hide button that appears. To make it appear again, hover your cursor near the edge of the page and click the Show button .

Space overview & space header

The space header sits at the top of the editor, and offers options that apply to the whole space.

The space overview contains information about the space you’re currently viewing. It lets you do things like publish and share your space, configure GitHub or GitLab sync, and more.

The space overview & space header may look different depending on the mode you’re currently in. See change requests for more info.

Space overview

The space overview appears at the top of GitBook when viewing a space. It includes:

• The space’s breadcrumbs A full, linear list of the collections or docs sites the space lives in.

• Collaborators The avatar of anyone else who’s currently viewing a page in your space, with colored circles to show their cursor color. Click an avatar to jump to the page they’re currently viewing.

• Git Sync configuration The GitHub and GitLab Sync configuration for your space.

• The Share menu Allows you to publish and share your space. You can also invite others to collaborate through this menu.

• Actions menu Offers a list of actions for your space. Similar to page actions, the available actions for a space will differ depending on the mode you’re currently in.

Space header

The space header is located directly beneath the space overview, and lets you collaborate with others on your space, customize it’s look, and more. It includes:

• The space emoji or icon You can choose an emoji or icon for your space, to help you easily identify it in the sidebar.

• The space name The name of the space that will appear in the sidebar, and your documentation if and when you choose to publish it.

• Comments See the comments and discussions you and your team have had about the space content.

• Broken links Any broken links that have been found in the current space or change request.

• Change requests Create, update, and delete change requests in your space.

• The edit button If your space is published, or someone has locked live edits, the Edit in change request button will appear in the space header. It lets you start a new change request to edit content.

Content editor

The editor is the main part of your space, where you can write or insert content in GitBook.

In addition to the multiple content blocks you can insert, you can also embed content from other places, such as integrations.

Page title and description

At the top of each page you can set a title, add an optional emoji, and write a description. The title you use will appear in the table of contents, and forms your page’s URL slug when published.

Your page description can be a maximum of 200 characters long, and will act as the preview text for your page in search engines.

You can change the URL slug for a page by choosing Page Actions > Rename. Find out more about Page Actions below.

The Actions menu

The page’s Actions menu allows you to do things like duplicate, rename or delete your page.

You can open the Actions menu using the icon that appears when hovering over your page in the sidebar, or from the icon next to the page title.

The type of actions available will depend on whether you’re in live editing mode, a change request, or in a space with locked edits.

Page options

The Page options side panel offers customization options for your documentation and navigation.

With page options, you to customize your documentation layout and navigation. You can only access page options if you’re in an editing mode.

You can open the Page options side panel by opening the page’s Action menu and choosing Options, or by hovering over the main title of the page and clicking Page options when it appears.

Certain changes, such as disabling the table of content, only apply to published documentation and may not be visible in the editor.

Page outline

The page outline shows H1 and H2 headings, allowing you to quickly jump to a specific section on an individual page.

The page outline sits on the right-hand side of the editor, and makes it easy to jump directly to the section of the page you’re looking for.

Any Heading 1 or Heading 2 blocks you add to the page will appear in the page outline listed here.

The page outline will appear in your published site, too. You can toggle it on or off in the Page options side panel.

If you can’t see the right-hand column of the app, it may be because your browser window is less than 1430 pixels wide. Your browser window needs to be at least 1430 pixels wide to see and use the page outline.