SUMMARY.md

Table of contents

Getting Started

• GitBook Documentation
• Quickstart
• Importing content
• GitHub & GitLab Sync
  • Enabling GitHub Sync
  • Enabling GitLab Sync
  • Content configuration
  • GitHub pull request preview
  • Commit messages & Autolink
  • Monorepos
  • Troubleshooting

Creating Content

• Formatting your content
  • Inline content
  • Markdown
• Content structure
  • Spaces
  • Pages
  • Collections
• Blocks
  • Paragraphs
  • Headings
  • Unordered lists
  • Ordered lists
  • Task lists
  • Hints
  • Quotes
  • Code blocks
  • Files
  • Images
  • Embedded URLs
  • Tables
  • Cards
  • Tabs
  • Expandable
  • Stepper
  • Drawings
  • Math & TeX
  • Page links
  • Snippets
• Reusable content
• Broken links
• Searching content
  • Search & Quick find
  • GitBook AI
• Writing with GitBook AI
• Version control

API References

• OpenAPI
  • Add an OpenAPI specification
  • Insert API reference in your docs
• Guides
  • Structuring your API reference
  • Adding custom code samples
  • Managing API operations
  • Describing enums
  • Integrating with CI/CD

---

• Extensions reference

Publishing Documentation

• Publish a docs site
  • Public publishing
  • Private publishing with share links
• Site structure
  • Content variants
  • Site sections
• Site customization
• Set a custom domain
• Setting a custom subdirectory
  • Configuring a subdirectory with Cloudflare
  • Configuring a subdirectory with Vercel
• Site settings
• Site insights
• Site redirects
• Visitor authentication
  • Enabling visitor authentication
  • Setting up Auth0
  • Setting up Azure AD
  • Setting up AWS Cognito
  • Setting up Okta
  • Setting up OIDC
  • Setting up a custom backend
• Adaptive content
  • Enabling adaptive content
  • Adapting your content
  • Testing with segments

---

• LLM-ready docs

Collaboration

• Live edits
• Change requests
• AI change requests
• PDF export
• Inviting your team
• Comments
• Notifications

Integrations

• Install and manage integrations
• GitHub Copilot
• Slack (beta)
• Visual Studio Code (alpha)

Account management

• Plans
  • Legacy pricing
  • Sponsored site plan
  • Non-profit plan
  • Billing policy
• Subscription cancellations
• Personal settings
• Organization settings
• Member management
  • Invite or remove members
  • Roles
  • Teams
  • Permissions and inheritance
• SSO & SAML
  • SSO Members vs non-SSO

Snippets

• Overview
• Snippets (beta)

Resources

• GitBook UI
• Keyboard shortcuts
• Glossary