Comment on page
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 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:
- Trash Deleted spaces appear in the trash. You can restore them for up to seven days — after that, they’re permanently deleted.
The table of contents lists all the pages and links in your selected space.
From the table of contents you can:
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
The space header sits at the top of the editor, and offers options that apply to the whole space.
The space header appears at the top of GitBook when viewing a space. It includes:
- The space emoji You can choose an emoji 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.
- 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.
The space sub-navigation is located directly beneath the space header, and lets you collaborate with others on your space, customize it’s look, and more. It includes:
- File manager Upload and manage files in your space.
The page title appears at the top of the page. You can set an emoji for a page by clicking the icon to the left of the title.
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.
GitBook’s block-based editor offers plenty of flexibility to add and reorder content, or embed rich content like code blocks and integration blocks.
The editor is where you can write or insert content in GitBook.
In the Page Actions menu, you can carry out actions that apply to the entire page.
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 Page options menu offers customization options for your documentation and navigation.
You can open the Page options menu 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.
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 block inserted on the page will appear in the page outline listed here.
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.
Last modified 2d ago