Skip to main content

GitBook

Connect GitBook to 1up

The GitBook integration pulls pages from your GitBook spaces into the 1up Knowledge Base and keeps them in sync. Setup involves creating a personal access token in GitBook and pasting it into 1up, then choosing whether to bring in a whole space or select individual pages.

Create a GitBook API token

A GitBook token carries the same access and privileges as the account that created it, so treat it like a password.

2. Click Create new API token.

3. Enter a name in the Label field, such as 1up.

4. Click Create.

5. Click Copy. The token is only visible once, so copy it before closing the window.

Link 1up to your Gitbook

Open the Knowledge Base in 1up.

2. Click +Add Knowledge in the top right.

3. Select GitBook from the list of knowledge sources.

4. Paste your token into the API token field.

5. Click Connect.

Select a space

  1. Click your organization in the Select Pages from GitBook window. Your spaces are listed underneath.

  2. Choose how much of a space you want:

    • Click Import & sync to bring in the full space.

    • Click the arrow next to a space to expand it and select individual pages.

Import and sync a whole space

Import & sync brings every page in a space into the Knowledge Base and keeps the two in step. Pages added in GitBook are added to the Knowledge Base, and pages deleted in GitBook are removed from it.

  1. Click Import & sync on the space you want.

  2. Wait for the pages to appear in the Knowledge Base.

Use this option for spaces you want mirrored, such as a docs site your team updates often. To pick a smaller set of pages instead, use the steps in Import individual pages.

Import individual pages

Note: Both options stay in sync. If you import a space, pages you add, edit, or delete in GitBook are reflected in your knowledge base automatically, including any new pages added to that space later. If you select individual pages, those pages stay in sync the same way, but new pages added to the space are not pulled in unless you select them.

  1. Review the pages listed for the space. Nested pages appear with their parent, such as Getting Started / Installation.

  2. Click each page you want to import. Selected pages appear as chips at the bottom of the window.

  3. Click the X on a chip to remove a page from the selection.

  4. Click Upload.

5. The selected pages will appear in your knowledge base.

Did this answer your question?