Skip to main content
GitBook is split into different sections to make it easier to organize and manage the content you create. The sidebar allows you to see an 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

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.

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

By default, the table of contents shows 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. The table of contents is also where you can view and manage reusable content and files for your space.
From the Pages tab in the table of contents you can:
  • Create new pages and subpages
  • Create page groups
  • Add external links
  • Access the Actions menu for individual pages
In the Library tab, you can:
  • View and search for reusable content, variables, images and files in the space
  • View and insert reusable content from other spaces
  • Create or import new items in the Library
  • Drag and drop Library items onto the page
  • Double-click to rename any Library item
  • Preview images
  • Manage and download images and files
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.

​
Space header

The space header contains information about the space you’re currently viewing. It lets you do things like publish and share your space, view the comments and history for the space, configure GitHub or GitLab sync, and more.
The space header is adaptable, and changes depending on the space and mode you’re currently in. For example, if you’re editing a change request, you will see an overview of the change request, alongside options to open the editor, view changes and merge your change request.
The space header 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.
  • The space’s breadcrumbs — A full, linear list of the collections or docs sites the space lives in.
  • Actions menu — Offers a list of actions for your space. The available actions will differ depending on the mode you’re currently in.
  • Overview — When viewing a change request, this tab shows the title and description of the change request, along with the participants and reviewers.
  • Editor view — This view is where you can make edits to your content using GitBook’s block-based editor.
  • Changes view — This view highlights the changes made within a change request using the diff view.
  • Preview — This view allows you to quickly see a preview of your content before you merge a change request.
  • Collaborators — The avatar of anyone else who’s currently viewing a page in your space.
  • 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.
  • Variables — Create and add reusable variables to use in a space.
  • GitBook Agent — Collaborate on changes in a space with GitBook Agent.
  • Comments — See the comments and discussions you and your team have had about the space content.
  • Change requests — Create, update, and delete change requests in your space.
  • Space history — View a version history that includes all the changes made in the space over time.
  • The Edit button — If your space is published, or someone has locked live edits, the Edit button will appear in the space header.
The site header contains information about the site you’re currently viewing. It lets you do things like view site insights, customize your site, change its settings and preview the site in different modes and screen sizes. The site header includes:
  • The site name — The name of the space that will appear in the sidebar and your documentation.
  • The site’s breadcrumbs — A link back to the main Docs sites screen.
  • Overview — The site overview shows you essential information about your site including its URL, publish status, audience and content, as well as top-level insights.
  • Insights — The insights panel gives you detailed analytics about your site and how it’s performing.
  • Customization — Here you can customize your site with your own logo, colors, header links, and much more.
  • Settings — Access your site’s settings and control the name, audience, content structure and other options.
  • Preview — The preview tab lets you quickly see how your published site will look in light and dark mode across desktop and mobile displays.
  • Integrations — The button opens a modal that lets you install and configure integrations for your site.
  • Member access — View and manage who can access your site in the GitBook app, and what permissions they have.
  • Visit site — Click this to instantly open your published docs site in a new tab. This button only appears when your site is live.

​
Content editor

The editor is the main part of your space, where you can write or insert content in GitBook. It supports multiplayer, meaning you and your team can collaborate on changes in real-time. You can insert content blocks, type Markdown, embed content, and collaborate on changes with GitBook Agent. In addition to working on changes, you can also comment on blocks, tag teammates, and more.

​
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.

​
Page 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 or a change request.

​
Page options

With page options, you can 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 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 headings 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.

​
Toolbar on published sites

When viewing your live docs site, you may see a toolbar appear at the bottom of the browser window. It provides quick access to useful options with a click:
  • Open the editor to view and edit your site’s content
  • Open your site’s settings in GitBook
  • Open your site’s customization settings
  • View your site’s insights
The toolbar is only visible to logged-in members of your GitBook organization. Site visitors who are not members of your GitBook organization will not see the toolbar.

​
When does the toolbar appear?

You will see the toolbar in the following situations:
  • Viewing your live site while logged into GitBook
  • Previewing earlier versions of your site through your version history
  • Previewing links for proposed changes, such as in a change request created in GitBook or a pull request created through Git Sync

​
Can I hide the toolbar?

Yes. By clicking the last button on the toolbar, you can choose between different options to change how the toolbar is displayed:
  1. Minimize — This reduces the toolbar to a small orb. To expand it again, you only have to click it.
  2. Close for one session — Fully removes the toolbar in the current tab until you close it.
  3. Don’t show again — Hides the toolbar and remembers your choice. You can restore the toolbar by clearing your browser’s local storage.

Build docs developers (and LLMs) love

Get started for freeTalk to us