Quick start

This page summarizes all the essentials you will need to know to start with GitBook. Here you can find all best practices and tips to set up your organizations, spaces, and content.

Spaces

A space is a project where you can brainstorm and organize your ideas. You can create spaces by projects/docs and/or teams.

Tips: You can synchronize one GitHub repo with a space.‌

You can read more about spaces and GitHub synchronization here:

Structure your docs

Once you created your space you can start writing.

Tips: You can use our import feature to easily import your content.‌

Table of Content

Structure and build your Table of Content first, several ways to do that: pages, groups, nesting, external links, variants.‌

Headings

GitBook offers 3 levels of headings, which will help you structure your paragraphs.

Tips: If you have too many headings, your content might be too long. Splitting your content into different pages can be a better reader experience.

Rich text and rich content

Make your content powerful by formatting your text and adding embeds, images, emojis, code samples...‌

If you want to get more details on all GitBook editing features you can have a look here:

Collaboration

The best way to start collaborating on GitBook is by inviting members to your organization.

You can learn more about organizations here:

Invite members and create a team

Once your organization has been created, you can start inviting members. Define their roles by giving them permissions, create teams for different spaces and put someone in charge of the administrative policy.

Tips: For big organizations, having someone in charge of commenting, reviewing and merging is a good practice to manage your docs.

Creation of drafts

Once you start editing, a draft is automatically created. This can be a first version of your content which can later on be subject to some changes. With the help of conflict resolutions you can edit the same page at the same time with other members of your organization. Once you have finished writing your content, you can save your work by clicking on the green button on the right.‌

Changes are proper to each draft, so nobody can break anything!

Tips: We recommend to name your drafts, give them a topic. This will help to review changes before merging drafts and allows you to see exactly what you or others have been working on.‌

Comments

Writing content is no longer a lonely experience, other writers can provide valuable feedback and review your work before merging changes. That way you can help your team to improve their drafts.

Activities

Thanks to activities anyone can see what has been done on your documentation. See changes, add reviews, comments and restore drafts.‌

Version control

No need to worry about changes that have been deleted, you can restore a previous draft any time!

You can read more about collaboration in here:

Customization‌

Add fonts, colors and header themes to personalize your content.‌

You can see all the customization options here: