Gitbook

GitBook

When to Use

USE GitBook when:

• Team documentation - Collaborative docs with multiple editors
• Product documentation - User guides, API docs, tutorials
• Knowledge bases - Internal wikis and knowledge management
• Multi-version docs - Maintain docs for different product versions
• Git-based workflow - Sync docs with GitHub/GitLab
• Custom branding - Need custom domains and styling
• Access control - Restrict docs to authenticated users

DON'T USE GitBook when:

• Complex code docs - Use Sphinx for Python API docs
• Static site control - Use MkDocs or Docusaurus
• Offline-first - GitBook is primarily cloud-hosted
• Self-hosted required - GitBook is SaaS (legacy self-hosted deprecated)

Prerequisites

GitBook Account Setup

# 1. Sign up at https://www.gitbook.com/
# 2. Create an organization (or use personal space)
# 3. Generate API token at https://app.gitbook.com/account/developer

export GITBOOK_API_TOKEN="gb_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

curl -s -H "Authorization: Bearer $GITBOOK_API_TOKEN" \
    "https://api.gitbook.com/v1/user" | jq '.id, .displayName'

Git Sync Setup

# In your GitBook space settings:
# 1. Go to Integrations > Git Sync
# 2. Connect GitHub/GitLab account
# 3. Select repository and branch

See sub-skills for full details.

Python Setup

uv add requests python-dateutil

Resources

• GitBook Documentation: https://docs.gitbook.com/
• GitBook API Reference: https://developer.gitbook.com/
• Git Sync Guide: https://docs.gitbook.com/integrations/git-sync
• Custom Domains: https://docs.gitbook.com/published-documentation/custom-domain

Version History

• 1.0.0 (2026-01-17): Initial release — spaces management, collections, variants, Git sync, collaboration, custom domains, migration tools, analytics, GitHub Actions

Sub-Skills

• 1. API Authentication (+1)
• 3. Content Management (+1)
• 5. Content Variants (Versions) (+1)
• GitHub Actions for Git Sync (+1)
• 1. Structure Content Properly (+3)
• Common Issues
• Getting Started
• User Guide
• API Reference
• Example 1: Documentation Site Builder (+2)