Integration · Updated
GitBook integration for usedocs
Moving off GitBook should not mean rewriting your docs or breaking every link customers bookmarked. The GitBook import brings the content and the paths with it.
TL;DR
Short answer
The usedocs GitBook integration imports a GitBook space as help center drafts, keeping redirects from the old paths. After review and publishing, usedocs keeps those articles current with edits from merged pull requests and drafts from customer questions.
Overview
Provide access to your GitBook space and usedocs imports its pages as drafts, organized into collections, with redirects from the old paths so links and search rankings carry over. Review the drafts and publish when ready. If you would rather keep GitBook as your public site, skip the import: use the usedocs widget or Answer API on top of it and still get drafted articles from the questions customers ask. Before switching your domain, compare the twenty most visited pages side by side and fix anything the import did not carry over, such as custom blocks or embedded diagrams. Then point your domain or subfolder at usedocs; the redirects take care of bookmarks and search results.
What this integration does
Import a space
Pages arrive as drafts, grouped into collections.
Redirects included
Old paths redirect to the new articles.
Review before publishing
Nothing goes live without approval.
Then keep it current
Edits from merged PRs and drafts from customer questions.
Setup
Open Import In Help center, open Import and choose GitBook.
Connect the space Provide a GitBook token and the space to import.
Review drafts Check the imported articles and collections, then publish.
Point your domain Set a custom domain or subfolder when you are ready to switch.
Limits and plan notes
- Imports create drafts for review.
- Large spaces take longer to import.
- GitBook specific blocks may not map one to one.
- Keep tokens scoped and rotate them after import.
Not for you if
Skip the import if you want to keep GitBook as the public site; use the widget or Answer API on top of it instead.
FAQ
What does the GitBook integration do?
It imports a GitBook space into usedocs as help center drafts, with redirects from old paths.
Will my links break?
No. Old paths redirect to the new articles.
Can I keep GitBook?
Yes. Use the usedocs widget or Answer API on your GitBook site instead of importing.
Does imported content stay current?
Yes. Merged pull requests propose edits and customer questions become drafted articles.
Is anything published automatically?
No. Imported articles are drafts until you publish them.
Can I import more than one space?
Yes. Import each space; its pages arrive as drafts you can organize into collections.