Introduction
Write your docs in GitBook's rich editor. Host them anywhere.
GitBook is a great editor for writing documentation, but hosting is limited to GitBook's own platform. If you want full control over your site with custom domains, your own CI/CD pipeline and no vendor lock-in, you need an alternative way to build and publish your content.
How it works
GitBook stores your content as Markdown in a Git repository via GitHub Sync. This plugin lets Docusaurus understand GitBook's custom syntax, so you can build a static site from that same repo.
- Write in GitBook's editor. Use rich blocks, tabs, hints, embeds, and more
- Sync to GitHub automatically via GitBook's Git Sync feature
- Build with Docusaurus + this plugin to produce a static site
- Deploy anywhere, like GitHub Pages, Netlify, Vercel, S3, or any static host
Your content stays in Markdown in your Git repo. No lock-in. If you ever want to switch away from GitBook, your content is already in a standard format.
Supported blocks
This plugin handles GitBook-specific syntax that standard Markdown processors don't understand:
| Block | Description |
|---|---|
| Hints | Info, warning, danger, and success callouts |
| Tabs | Tabbed content panels |
| Stepper | Numbered step-by-step guides |
| Columns | Side-by-side column layouts |
| Code blocks | Code blocks with titles and line numbers |
| Embeds | Embedded external content (YouTube, etc.) |
| Files | File download links |
| Buttons | Primary and secondary action buttons |
| Cards | Card grid layouts |
| Icons | Font Awesome icons |
| OpenAPI | OpenAPI/Swagger endpoint documentation |