| Cover image (dark) | Cover image (dark) | Cover image (dark) | Cover image (dark) | Cover image (dark) | Cover image | |||
|---|---|---|---|---|---|---|---|---|
| Quickstart | Get up and running with GitBook in just a few minutes | /files/iuQzSs10N2B09IKNSn6N | /files/xuYYEi9GOFjz34mx8rwJ | /pages/LeZB5bRRRrTrkSl678Cp | /files/QbVBImJwrA69yjwwaY86 | |||
| Git Sync | Sync with a Git repository to enable docs-as-code workflows | /files/ZqNtFc7X9jpeNpt7xRVf | /files/NfaksvU8IDsXlMsvZpYM | /pages/HzpkoWwYu6eCKccs3i93 | /files/NxPeEVgxZw0iNq1sTsA7 | |||
| Create content | Create and format your docs using our block-based editor | /files/QPQwWWPi9Kj6uTWVWUBf | /files/Ip117gadKsUrTcCWFa73 | /pages/m5Yqxmw2ZT0HNZdTJPvi | /files/TCsSotUzkpHXfsiITXwR | |||
| Publish your docs | Publish your docs site to share with others | /files/YytByXjf9asxOazY8QFV | /files/QGUFPJo987lHWyywP4nJ | /pages/LhRX6q09LqLQChgHEgh8 | /files/WJF7hXUYFl95qQfmsqAW |
| Essentials | |
| AI-native docs | |
| Popular topics |
| :sparkles: | AI Assistant | Embed the Assistant in your product and give users relevant answers trained on your docs — and other tools you choose to connect. | /pages/m6LOhkgWYpmL4u1LYydz |
| :robot: | GitBook Agent | Get proactive suggestions for docs updates based on support tickets, release notes and more — or ask the Agent to review your work. | /pages/KHHFlE1MtpVIaZboN8b2 |
| :language: | Translations | Translate your docs into any language with a click, and watch them automatically update every time you edit your primary content. | /pages/SCIhFLnUtEbtkZm5zN9x |
| :server: | MCP server integration | Your site’s hosted MCP server lets users connect your docs to other tools so they can pull knowledge whenever they need it. | /pages/biYvWYyOTbkQs94S5MI1 |
The import panel in GitBook.
Set up Git Sync for your GitBook space.
GitHub Sync configuration options.
GitLab Sync configuration options.
Autolink setup.
Update the settings for your published documentation.
You can create all kinds of site designs using GitBook’s built-in customization options.
The customization panel in GitBook.
This menu gives you a visual idea of how the different styles will change the look of your sidebar.
| Cover image (dark) | Cover image | Cover image (dark) | ||||
|---|---|---|---|---|---|---|
| Site sections | Split your site into distinct parts — ideal for multiple products or parts of your organization. | /files/jCp95LXOba5SJ05eragF | /files/R89ivAvJAE76NMEwpYNr | /pages/BhYaMwXvRKZYVdHgZM5T | /files/84E3evM3hCGW0RAWhn3C | |
| Content variants | Publish multiple versions of the same content — ideal for localization, versioning, and more. | /files/S17Cf7AIte2wqtwrQJ2f | /files/ztYwJupTRWGUjAvs9Kxs | /pages/VYD1uYVNjSTqX4nw00s3 | /files/rhJWb29YSNvxnb5BrpMf |
The structure of a published docs site.
Update a site section or variant.
Example of a GitBook site with site sections
Add structure to your docs with site sections.
Choose the search experience you want in your published docs
| Cover image | Cover image (dark) | Cover image (dark) | Cover image (dark) | ||
|---|---|---|---|---|---|
| Configuring a subdirectory with Cloudflare | /pages/YKhnnDBGRdiG0J9NrQ2q | /files/cNDCU8Ykl27ZQthgXvCl | /files/A0XGOp4BDPkL62ScLfRL | /files/A0XGOp4BDPkL62ScLfRL | /files/HM0FsOPWw2bUEqwORRay |
| Configuring a subdirectory with Vercel | /pages/4YDmCzJDaEnyghAUtKuL | /files/0SPPyHkRUU8jz3DhrRnu | /files/4PfSotd6WoWit4gyCcad | /files/4PfSotd6WoWit4gyCcad | /files/wX5dnvisXzuUNmD8nOLQ |
| Configuring a subdirectory with AWS | /pages/V84lyzF3H4YEMHlzA2wa | /files/LbBjBevnm2BvX1gU1RaI | /files/Ck2ktsqVtDj9Kk5zriQI | /files/JtVbcTzLsmcJf8QcpoAm |
GitBook's docs sites homepage.
| Cover image | Cover image (dark) | Cover image (dark) | Cover image (dark) | ||||
|---|---|---|---|---|---|---|---|
| Public | Publish your docs publicly to the web. | /files/47vaeglRmjg9U9XaHhvE | /pages/vNPy4P2eYrZWKuUu8zFz | /files/iHKxWZZLBnk7N1CSSbdl | /files/iHKxWZZLBnk7N1CSSbdl | ||
| Privately with share links | Publish your docs with private share links. | /files/qK0AXRwT4Lq7gbRZ8yiF | /pages/g5jAmnNJPWR6JjBFis2I | /files/dY3MZAa1zAI2NbIE90Pn | /files/mgBprbZYBZ6nW42ewzHx | ||
| Authenticated Access | Protect your published docs behind an OAuth sign in. | /files/j20Zpf48GM8QbfO86jQX | /pages/Yn7gzayRYsbHAIeByLZu | /files/5oN43u01wtVPnHfvq2ko |
Site redirects are useful when migrating documentation or restructuring content to avoid broken links, which can impact SEO.
You can find the GitBook admin URL for a page in this menu
Embed your docs into your product or website
| :code: | Standalone script tag | Drop in a <script> tag for the fastest setup, then customize its appearance | /pages/ouLg49uGmmRI4GNPjfEd |
| :box: | Node.js/NPM | Install via NPM for server-side rendering or build-time control | /pages/efDLEfySio5adqVBlQ9V |
| :react: | React component | Use prebuilt React components for seamless integration | /pages/GH6SGgYGRjfMQZnvf1UP |
Please sign in to access help.
Sign inSupport handoff is a great way to get started with custom tools. It’s the fastest way to unblock users.
AI insights screen.
Topic detail view in AI insights.
Question detail view in AI insights.
The site analytics dashboard.
Add inline elements to your content.
```
{% endcode %}
## Emojis
You can add emojis by hitting `/` to open the inline palette. Alternatively, type `:` and a list of emojis will pop up directly in line — you can start typing the name of an emoji to narrow down the selection.
### Representation in Markdown
{% code overflow="wrap" %}
```markdown
:house:
:car:
:dog:
```
{% endcode %}
## Links
You can insert three different types of links:
* [Relative links](#relative-links)
* [Absolute links](#absolute-links)
* [Email address `mailto` links](#email-address-mailto-links)
### Relative links
Relative links are links created by linking to [pages](/docs/creating-content/content-structure/page) that already exist in your space. The advantage of using relative links is that if the page’s URL, name, or location changes, its reference will be kept up to date — so you’ll end up with fewer broken links.
Here’s how to insert a relative link:
1. Click somewhere in your paragraph where you want to insert the link, or select some text.
2. Hit / to open the inline palette and choose Link, click the **Link** button in the context menu, or hit **⌘ + K**.
3. Start typing the title of the page you want to link to.
4. Select the page from the drop-down search results.
5. Hit `Enter`.
### Absolute links
Absolute links are external links that you can copy and paste into your content. They’re great when you want to link to something outside your documentation.
To insert an absolute link:
1. Click somewhere in your paragraph where you want to insert the link, or select some text.
2. Hit / to open the inline palette and choose Link, click the **Link** button in the context menu, or hit **⌘ + K**.
3. Paste the URL you want to link to.
4. Hit `Enter`.
{% hint style="info" %}
**Why don't external links open in a new tab?**
When you add a link to an external site in your docs, it will open in the same tab.
GitBook follows this [W3C-recommended behavior](https://www.w3.org/TR/WCAG20-TECHS/G200.html) to support [accessibility](https://it.wisc.edu/learn/make-it-accessible/websites-and-web-applications/when-to-open-links-in-a-new-tab/) and ensure a consistent, inclusive experience for your readers.
{% endhint %}
### Email address mailto links
Email address `mailto` links are useful when you want your visitors to click on a link that will open up their default email client and fill in the `To` field with the email address of your link, so they can write an email to send.
Here’s how to insert an email address `mailto` link:
1. Click somewhere in your paragraph where you want to insert the link, or select some text.
2. Hit / to open the inline palette and choose Link, click the **Link** button in the context menu, or hit **⌘ + K**.
3. Paste or type `mailto:something@address.com`, replacing `something@address.com` with the email address you would like to use.
4. Hit `Enter`.
### Representation in Markdown
```markdown
[This is a relative link to another page in this space](../content-structure/page.md)
[This is an absolute link](https://www.gitbook.com/blog)
[This is a link](mailto:support@gitbook.com) to our support email address
```
## Math & TeX
Using this option, you can create an inline math formula in your content, like this: $$f(x) = x \* e^{2 pi i \xi x}$$. We use the [KaTeX](https://katex.org/docs/supported.html) library to render formulas.
{% hint style="info" %}
You can also insert [a block-level math formula](/docs/creating-content/blocks/math-and-tex) by opening the command palette in an empty block and choosing the second Math & TeX option.
{% endhint %}
### Representation in Markdown
```markdown
# Math and TeX block
$$f(x) = x * e^{2 pi i \xi x}$$
```
## Buttons
Buttons are a great way to highlight calls to action or add a search or Ask AI bar to your docs. You can use them to send readers somewhere, or help them find answers.
### Button actions
Buttons can do more than link to a URL. You can also turn a button into a search or ask GitBook Assistant bar — right from the page. These actions work on published pages, too — as you can see from the examples belo
You can configure the following actions:
#### **Add a link button**
Send readers to another page or an external URL:Learn more about Assistant
#### **Add a search bar**
Open search with an optional preset query:
#### **Add a Ask AI/GitBook Assistant bar**
Open [GitBook Assistant](/docs/ai-and-search/gitbook-ai-assistant) with an optional preset prompt:
#### **Add a disabled button**
Show a button that’s intentionally inactive:Inactive button
### Create and configure a button
1. Type `/` and choose **Button**.
2. Click the button to open the **Label** menu.
3. Choose an action, then set the label and style.
4. Optional: add a preset search query or Assistant prompt.
### Styles
Link and inactive buttons have both primary and secondary styles. Here are a couple of examples:
Sign up to GitBook Go to top
### Representation in Markdown
```markdown
GitBook
```
## Icons
Icons allow you to add extra visual indications to your site. You can add them inline to paragraphs, inside a card, or anywhere else you need to add some flair. They will use the visual style defined in your [customization settings](/docs/docs-site/customization/icons-colors-and-themes).
:facebook: :github: :x-twitter: :instagram:
Visit [Font Awesome](https://fontawesome.com/) to explore the different icons available.
### Representation in Markdown
```markdown
:github:
```
## Expressions
Expressions allow you to dynamically display content defined in a [variable](/docs/creating-content/variables-and-expressions). Expressions can be inserted from the `/` menu. Once inserted, clicking on the expression will bring up the expression editor, allowing you to reference and [conditionally format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_operator) your variable.
# Markdown
Write Markdown directly in the editor to easily create content using common syntax
Write Markdown in GitBook.
| Cover image (dark) | Cover image | Cover image (dark) | |||
|---|---|---|---|---|---|
| Spaces | Create a space to organize your documentation in one place. | /files/YaGmUbXRgaRXXSDCxCOW | /pages/moDj3PEk7p2zQgeFnQeb | /files/8H91vCxYt417FwCXU47O | /files/RT2KZj58Pwl5LQCVOPsY |
| Pages | Create pages to split up and edit the content in your documentation. | /files/8YSQLnUUVs9loZUMYowy | /pages/rQjvGxGcUeJWEOCurV8r | /files/GZvdqpNfPrKZbQo8LIs6 | /files/WI0Nn32gFMXXWZWC6K5F |
| Collections | Create collections to group spaces together. | /files/cNLtXHiB8iSgh246ZhSR | /pages/e9ggdMSZiVMkRxIMXuwb | /files/AOaOSF0tWX9LnAXvRmmm | /files/JQsGLet62uI6oeAYtJe5 |
An empty page in GitBook. You can see it listed in the table of contents on the left-hand side.
---
hidden: true
---
GitBook's built in content blocks.
image
- This is a second line using an unordered list and color
{% endhint %}
```
# Quotes
Add a quote block to a page to highlight copy you’re adding from elsewhere, or to draw attention to a specific part of your text
Quotes are useful when you want to include something from another source.
Start a quote by typing `>` followed by pressing `Space` in an empty paragraph, or use the[ insert palette](/docs/creating-content/blocks#inserting-a-new-content-block). You can also convert a paragraph block to a quote by highlighting the entire paragraph and hitting `>`.
### Example of a quote
> "No human ever steps in the same river twice, for it’s not the same river and they are not the same human." — *Heraclitus*
### Representation in Markdown
{% code overflow="wrap" %}
```markdown
> "No human ever steps in the same river twice, for it’s not the same river and they are not the same human." — _Heraclitus_
```
{% endcode %}
# Code blocks
Add a code block to a page to include sample code, configurations, code snippets and more
You can add code to your GitBook pages using code blocks.
When you add a code block, you can choose to [set the syntax](#set-syntax...), [show line numbers](#with-line-numbers), [show a caption](#with-caption), and [wrap the lines](#wrap-code). It’s also easy to [copy the contents of a code block to the clipboard](#copying-the-code), so you can use it elsewhere
A code block may be useful for:
* Sharing configurations
* Adding code snippets
* Sharing code files
* Showing usage examples of command line utilities
* Showing how to call API endpoints
* And much more!
### Add a code block
1. To add a code block, place your cursor on an empty line and type `/`.
2. In the quick insert menu, select **Code block**.
3. GitBook inserts the block and places your cursor inside it, ready for you to paste or type code.
### Example of a code block
{% code title="index.js" overflow="wrap" lineNumbers="true" %}
```javascript
import * as React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(
Example of an image block with a caption
Resize an image
Framed images can have captions, and show a subtle grid behind the caption.
GitBook Logo
| Company | Status | Contact | MRR | Contact | MRR | Status |
|---|---|---|---|---|---|---|
| Ace AI – Design | In progress | rena@ace.ai | $450 | rena@ace.ai | $420 | In progress |
| Discrete Data – API | In progress | dave@dd.inc | $100 | dave@dd.inc | $69 | |
| Example Co | pete@example.com | $50 |
| Cover image | Cover image (dark) | Cover image (dark) | Cover image (dark) | |||
|---|---|---|---|---|---|---|
| GitBook homepage | Visit our website and find out more about GitBook. | https://www.gitbook.com/ | /files/QYueHfSoCIBfVtVewHzc | /files/KnkfYgkg09HoBEsTSvno | /files/KnkfYgkg09HoBEsTSvno | |
| Developer docs | Build you own GitBook integration! | https://developer.gitbook.com/ | /files/E0kdUrJTlzpisarQS1EN | /files/bUixHIAEp0eN14FD5yjX | /files/bUixHIAEp0eN14FD5yjX | |
| Sign up to GitBook | Click here to get started for free. | https://app.gitbook.com/join | /files/oVPX37No5jwWdJjJ6R8P | /files/nGNQbAPi1b7xLU187PjQ |
On desktop, all card images will display in a landscape 16:9 ratio, regardless of their dimensions. We recommend using the same dimensions for consistency.
On mobile, square or portrait images will displayed as shown on the left. Landscape images will be displayed as shown on the right.
| Example title 1 | Example description 1. | https://example.com | example_image1.svg |
| Example title 2 | Example description 2. | https://example.com | example_image2.svg |
| Example title 3 | Example description 3. | https://example.com | example_image3.svg |
## Example
### Step 1 title
Step 1 text
### Step 2 title
Step 2 text
```
# Math & TeX
Add a mathTeX block to a page when you want to display a mathematical formula in your documentation
You can use the mathTeX format to include mathematical formulae in your documentation. We offer this through the [KaTeX](https://katex.org/docs/supported.html) library.
You can also add mathTeX [as inline content](/docs/creating-content/formatting/inline#math-and-tex).
### Example of Math & TeX block
$$
s = \sqrt{\frac{1}{N-1} \sum\_{i=1}^N (x\_i - \overline{x})^2}
$$
### Representation in Markdown
$$f(x) = x \* e^{2 pi i \xi x}$$
```markdown
# Math and TeX block
$$f(x) = x * e^{2 pi i \xi x}$$
```
# Page links
Add a page link block to show relations between pages in your space.
Page link blocks are the best way create relations between different pages within your content. Page links stand out on the page as they fill their own block — compared to a hyperlink added to some text.
### Example of page link block
The links below point to [blocks](/docs/creating-content/blocks) and [inline content](/docs/creating-content/formatting/inline):
{% content-ref url="/pages/xm6T8EpV4FqtdPLzZ8qN" %}
[Blocks](/docs/creating-content/blocks)
{% endcontent-ref %}
{% content-ref url="/pages/DfnNkU49mvLe2ythHAyx" %}
[Inline content](/docs/creating-content/formatting/inline)
{% endcontent-ref %}
## Representation in Markdown
```markdown
{% content-ref url="./" %} . {% endcontent-ref %}
```
# Columns
Add a column to create different layouts in your documentation.
Columns are a great way to create different layouts for your documentation. You can add many different types of blocks inside a column, and adjust the width of each side to customize it to the design you need.
{% columns %}
{% column width="50%" %}
**Create a seamless experience between your docs and product**
Integrate your documentation right into your product experience, or give users a personalized experience that gives them what they need faster.
Learn more
{% endcolumn %}
{% column %}
## Example
### Create a seamless experience between your docs and product
Integrate your documentation right into your product experience, or give users a personalized experience that gives them what they need faster.
<a href="https://www.gitbook.com/#alpha-waitlist" class="button primary">Learn more</a>
<figure><img src="../../.gitbook/assets/GitBook vision post.png" alt="An image of GitBook icons demonstrating side by side column functionality"><figcaption></figcaption></figure>
You can add variables to a single page or an entire space. When you update the value of a variable, every instance of it will update.
You can add variables to your content within expresions. The expression editor offers autocomplete options to help you find the variable you need.
Create reusable content within a space.
Ask questions or search through your content using the built in search bar.
Invite your team to GitBook to collaborate on pages, spaces, and published sites.
| Reader role (your organization) | Public docs reader (site visitor) | |
|---|---|---|
| Invitation required | Yes | No |
| Paid seat | Yes | No |
| Content access | Published and unpublished (with permission) | Published only |
Edit your content through change requests.
| Change request screen | View and manage change requests across your entire organization | /pages/RtzwHmNAAMW6pYmEJshK |
| Change requests in a space | Create and review change requests in a single space | /pages/QahtV4lWA3JQnbMAvNKG |
View active change requests from the change requests screen.
| Rule | Description |
|---|---|
| Require at least one review | Ensures that at least one team member has reviewed the change request before it can be merged. |
| Require all reviews approved | All completed (not requested) reviews must be approvals. If any reviewer has requested changes or rejected the change request, the merge will be blocked. |
| Require review by specified actors | Requires approval from all specified users. You can select specific team members who must review and approve the change request before it can be merged. |
| Require review by one of specified actors | Requires approval from at least one of the specified users. This is useful when you have multiple qualified reviewers but only need one approval from the group. |
| Require Docs Agent review (coming soon) | Requires a review from the GitBook AI agent. This ensures automated quality checks are performed on content changes before merging. |
| Rule | Description |
|---|---|
| Require up to date change request | The change request must be current with the primary content branch. If the primary content has been updated since the change request was created, you’ll need to rebase or update it before merging. |
| Require subject | The change request must have a descriptive subject/title. Empty subjects will block the merge. |
| Require description | The change request must include a description explaining what changes were made and why. |
| Rule | Description |
|---|---|
| Allow specified actors to bypass requirements | You can designate specific users who are allowed to bypass all other merge rule requirements. This is useful for administrators or emergency situations where rules need to be overridden. |
| Custom expression | You can create advanced merge rules using custom JavaScript expressions. This allows you to define complex logic based on the evaluation context, with access to properties of the change request, reviews, and the user attempting to merge. |
Add a sign in to your published documentation.
| Cover image | Cover image (dark) | ||
|---|---|---|---|
| Setting up Auth0 | /files/gLopKD4HiKNlvhgvyriF | /pages/R83a8Qh2WeO7IV5QLQpp | /files/4Gm6ZsEYHJiikjjQG6xM |
| Setting up Azure AD | /files/za4aHvr2NRbfbdpEJ0q0 | /pages/bExJU6ah6xJ85CGUxXpW | /files/i99ytQBwFy39Xmd922zg |
| Setting up Okta | /files/sDfnjrOdPzbgBJcFAIw6 | /pages/hIfRqIeX6S7SMk12buNt | /files/YZKI5GDRbOvPCNV2JBky |
| Setting up AWS Cognito | /files/8V36WDKt7ynoizwxbSD1 | /pages/PyRnT9Rl3B2XzMHTrNEY | /files/YyDsrlH2cjqkb1UZycdR |
| Setting up OIDC | /files/7tvUt0D1Lt2xH021tyBj | /pages/tGPdipCjrVfRiibfR2kc | /files/an2wBPnTxg9LoioO6FWs |
| Setting up a custom backend | /files/1dEAlQu1ERR5BQPCGZT3 | /pages/1Z06lRawG4maeQOYXHnm | /files/h5zjuSICVyqGmyjhPcN4 |