1 of 11

ceohaonam

Trần Hạo Nam

Getting Started

Quickstart

Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content.

Want to learn about writing content from scratch? Head to the Basics section to learn more.

Import

GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.

Sync a repository

GitBook also allows you to set up a bi-directional sync with an existing repository on GitHub or GitLab. Setting up Git Sync allows you and your team to write content in GitBook or in code, and never have to worry about your content becoming out of sync.

Publish your docs

Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site. Once published, your site will be accessible online only to your selected audience.

You can publish your site and find related settings from your docs site's homepage.

Basics

Editor

GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.

Writing content

GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.

Either start typing below, or press / to see a list of the blocks you can insert into your page.

Markdown

GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!

Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.

# Heading

This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs. 

## Heading 2
- Point 1
- Point 2
- Point 3

If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.

Images & media

GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.

You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.

Interactive blocks

In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing / from within the editor.

Tabs

Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.

Add images, embedded content, code blocks, and more.

Expandable sections

Click me to expand

Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.

Drawings

Embedded content

OpenAPI

You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation.

OpenAPI block

GitBook's OpenAPI block is powered by Scalar, so you can test your APIs directly from your docs.

Integrations

GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the Integrations menu in the top left.

Types of integrations

OpenAPI

You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation.

OpenAPI block

GitBook's OpenAPI block is powered by Scalar, so you can test your APIs directly from your docs.

Add a new pet to the store

POST/api/v3/pet

Authorization

Body

Create a new pet in the store

idinteger (int64)

Example: 10

name*string

Example: "doggie"

categoryCategory (object)

idinteger (int64)

Example: 1

namestring

Example: "Dogs"

photoUrls*array of string

itemsstring

tagsarray of Tag (object)

idinteger (int64)

namestring

statusenum

pet status in the store

availablependingsold

Response

Successful operation

Body

idinteger (int64)

Example: 10

name*string

Example: "doggie"

categoryCategory (object)

idinteger (int64)

Example: 1

namestring

Example: "Dogs"

photoUrls*array of string

itemsstring

tagsarray of Tag (object)

idinteger (int64)

namestring

statusenum

pet status in the store

availablependingsold

Request

Response

Interactive blocks

In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing / from within the editor.

Tabs

Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.

Add images, embedded content, code blocks, and more.

const handleFetchEvent = async (request, context) => {
    return new Response({message: "Hello World"});
};

Expandable sections

Click me to expand

Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.

Drawings

Embedded content

GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones.

Add a new pet to the store

POST/api/v3/pet

Authorization

Body

Create a new pet in the store

idinteger (int64)

Example: 10

name*string

Example: "doggie"

categoryCategory (object)

idinteger (int64)

Example: 1

namestring

Example: "Dogs"

photoUrls*array of string

itemsstring

tagsarray of Tag (object)

idinteger (int64)

namestring

statusenum

pet status in the store

availablependingsold

Response

Successful operation

Body

idinteger (int64)

Example: 10

name*string

Example: "doggie"

categoryCategory (object)

idinteger (int64)

Example: 1

namestring

Example: "Dogs"

photoUrls*array of string

itemsstring

tagsarray of Tag (object)

idinteger (int64)

namestring

statusenum

pet status in the store

availablependingsold

Request

Response