How gitbookio/gitbook works
GitBook is a renderer for published technical documentation; the primary journey is a reader opening a published site and viewing its pages. The graph also preserves search, AI assistance, embeds, interactive integrations, OpenAPI rendering, and machine-readable/export routes visible in the repository tree. The README documents the published-content rendering purpose, while source excerpts and the index show selected internal dependencies; unsampled route-to-component wiring is therefore left out rather than inferred.
Main entry points: useSearchController.tsx Search Controller · sites Site Routes · DocumentView.tsx Document View · useSearchResults.ts Search Results
Components 22
Published Sites
- Site Routes
packages/gitbook/src/app/sites - Page Renderer
packages/gitbook/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/(content)/[pagePath]/page.tsx - Site Contexts
packages/gitbook/src/components/SiteLayout/SiteLayoutClientContexts.tsx
Content Rendering
- Document View
packages/gitbook/src/components/DocumentView/DocumentView.tsx - ContentKit Blocks
packages/gitbook/src/components/DocumentView/Integration/ContentKitWithClientContext.tsx - OpenAPI Rendering
packages/react-openapi/src/OpenAPIWebhook.tsx - Expressions
packages/expr/src/runtime.ts
Search and AI
- Search Controller
packages/gitbook/src/components/Search/useSearchController.tsx - Search Results
packages/gitbook/src/components/Search/useSearchResults.ts - Search Display
packages/gitbook/src/components/Search/SearchResults.tsx - Recent Queries
packages/gitbook/src/components/Search/recent-queries.ts - Result Ranking
packages/gitbook/src/components/Search/reciprocalRankFusion.ts - Search Routes
packages/gitbook/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/search/route.ts - AI Assistance
packages/gitbook/src/components/AI/useAIChat.tsx
Embeds and APIs
- Embed Routes
packages/gitbook/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/embed - Embed Client
packages/embed/src/client/createGitBook.ts - MCP Routes
packages/gitbook/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/mcp/route.ts - Content Exports
packages/gitbook/src/app/sites/static/[mode]/[siteURL]/[siteData]/llms.txt/route.ts
Site Services
- Site Services
packages/gitbook/src/app/sites - Revalidation
packages/gitbook/src/app/~gitbook/revalidate/route.ts - Incremental Cache
packages/gitbook/openNext/incrementalCache/incrementalCache.ts
Other components
- Reader
Connections 19
- Reader → Site Routes: opens published site
README.md - Site Routes → Page Renderer: renders pages
- Site Contexts → Search Controller: provides search context
packages/gitbook/src/components/SiteLayout/SiteLayoutClientContexts.tsx - Page Renderer → Document View: renders content
- Document View → ContentKit Blocks: renders integrations
packages/gitbook/src/components/DocumentView/Integration/ContentKitWithClientContext.tsx - Document View → OpenAPI Rendering: renders API blocks
- Search Controller → Search Results: requests results
packages/gitbook/src/components/Search/useSearchController.tsx - Search Results → Recent Queries: records queries
packages/gitbook/src/components/Search/useSearchResults.ts - Search Results → Result Ranking: ranks results
packages/gitbook/src/components/Search/useSearchResults.ts - Search Controller → Search Display: renders results
packages/gitbook/src/components/Search/useSearchController.tsx - Search Controller → AI Assistance: asks assistant
packages/gitbook/src/components/Search/useSearchController.tsx - Search Controller → Search Routes: fetches search
- Reader → Embed Routes: opens embed
- Embed Client → Embed Routes: connects to
- Reader → MCP Routes: uses MCP
- Reader → Content Exports: requests exports
- Site Routes → Site Services: serves site data
- Site Services → Revalidation: accepts revalidation
- Site Services → Incremental Cache: uses cache