Quickstart

Getting started

You’ll need a GitBook account to start publishing documentation.

Sign up

Create a docs site

When you first sign up, you’ll have a chance to create a docs site from the docs site wizard. You can launch the wizard again to create a new site at any point by clicking the + button next to the Docs sites header in the sidebar.

The docs site wizard will take you through the flow of creating your first site. You’ll need to give your site a name, choose if you want to start from scratch with an empty site or add our sample content, and whether or not you want to publish your docs right away.

Edit your content

Now that you’ve created a site, you can edit or import your content. If you have an existing repository on GitHub or GitLab with your documentation, you can easily migrate and sync your content to GitBook using Git Sync. Find out more in our guide to migrating content using Git Sync.

After importing your content, you can edit your pages using GitBook’s built-in editor and do things like add interactive blocks, customize the layout of your pages and more.

Check out these resources if you’d like to learn more about the editing experience in GitBook:

Start a change request

Collaborate on content with your team.

Install an integration

Integrate your favorite tools with your published site.

Add an OpenAPI spec

Add API methods directly into your docs.

Customize your site

Not only can you edit the content of your site, you can also customize many settings related to the look and feel of your site when it’s published.

You can change things like the logo, colors & fonts, add more structure through site sections and variants, or update your site’s visibility settings.

You can read more about customizing your docs in the resources below:

Customize your site

Customize the look and feel of your site.

Add a custom domain

Set up a custom domain for your site.

Update your site's settings

Update settings related to your published site.

Publish your documentation

Finally, you’re ready to publish your site into the world. If you haven’t already published your site from the wizard, you can publish your site from your site’s dashboard at any time.

After publishing your site, you’ll get a link that you’re able to share with anyone!

If you’re running into problems or have any questions, we’re here to help. Join our community or send our support team a message and we’ll help you from there.