GitBook Documentation llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/gitbook/llms-txt) # GitBook Documentation llms.txt gitbook.com/llms.txt [Raw llms.txt](https://gitbook.com/docs/llms.txt) [Raw llms-full.txt](https://gitbook.com/llms-full.txt) Copy Markdown [](https://gitbook.com/llms.txt) llms.txt Documentation Overview Quickstart Build with AI Agent skills GitBook MCP Optimizing for AI Migrate to GitBook GitHub & GitLab Sync Enabling GitHub Sync Enabling GitLab Sync Content configuration GitHub pull request preview Commit messages & Autolink Monorepos Troubleshooting New! Site workspace Site settings Site customization Icons, colors, and themes Layout and structure Sharing and social Extra configuration Site structure Site sections Content variants Multilingual sections AI Search Set a custom domain Setting a custom subdirectory Configuring a subdirectory with Cloudflare Configuring a subdirectory with Vercel Configuring a subdirectory with AWS using CloudFront and Route 53 Publish a docs site Public publishing Private publishing with share links Site redirects Embed in your product Implementation Script tag Node.js/NPM React Authentication Configuration Customizing the Embed Connect to custom tools API Reference AI insights Site analytics PDF export Formatting your content Inline content Markdown Content structure Spaces Pages Tags Collections Blocks Paragraphs Headings Unordered lists Ordered lists Task lists Hints Quotes Code blocks Files Images Embedded URLs Tables Cards Tabs Expandable Stepper Updates Drawings Mermaid blocks Math & TeX Page links Prompt Columns Conditional content Variables and expressions Reusable content Styleguide Searching internal content Search & Quick find GitBook AI Version control Inviting your team Member management Manage or remove members Permissions and inheritance Roles Teams Change requests Change requests screen Change requests in a space Merge rules Comments Notifications Live edits Authenticated access Enabling authenticated access 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 Cookies URL Feature flags Authenticated access Adapting your content Testing with segments GitBook Assistant Connections Intercom Zendesk Pylon GitHub Discussions GitHub Issues LLM-ready docs MCP servers for published docs What is GitBook Agent? Channels Automatic docs improvements Writing with GitBook Agent Review change requests with GitBook Agent Translations OpenAPI Add an OpenAPI specification Insert API reference in your docs Guides OpenAPI layouts Structuring your API reference Adding custom code samples Managing API operations Configuring the “Test it” button Using OpenAPI proxy Describing enums Integrating with CI/CD Extensions reference Install and manage integrations Plans Community plan Sponsored site plan Billing policy Legacy pricing Subscription cancellations Personal settings Organization settings SSO & SAML SSO Members vs non-SSO GitBook UI Toolbar on published sites and site previews Keyboard shortcuts Glossary Concepts Guides GitBook guides The complete guide to creating and publishing documentation in GitBook [updated for 2026] How to use GitBook’s editor How to collaborate on change requests How to use merge rules Import or migrate your content to GitBook with Git Sync Import content from a CSV file into GitBook How to handle merge conflicts in GitBook Embed a playable video into your GitBook docs Find & replace or make batch changes across your GitBook docs with Git Sync How to write documentation with AI 7 ways teams are using GitBook Agent to streamline their docs workflows (with prompt examples) How to make a great-looking docs site How to customize your site’s theme How to customize your site’s layout How to customize your site’s configuration Combine multiple existing sites into one using site sections Localize your docs with variants in GitBook Use GitHub Actions to translate GitBook pages GEO guide: How to optimize your docs for AI search and LLM ingestion How to use SEO techniques to improve your documentation Introducing AI into your product documentation workflow Build your docs around your users’ needs with documentation personas 7 ways to make your public documentation more useful for users 10 quick tips to improve your technical writing workflow in GitBook How to write incredible API documentation Document your API in GitBook in 5 simple steps API docs: The seven principles of great API docs and how to apply them Documentation analytics: which metrics to track and how to measure success Track documentation analytics with Google Analytics Track advanced analytics with GitBook's Events Aggregation API Analyze change request contributors with GitBook’s API How to personalize your GitBook site using URL parameters and adaptive content How to personalize your GitBook site using cookies and adaptive content How to personalize your GitBook site using Auth0 and adaptive content How to create branded documentation How to structure technical documentation: information architecture best practices Make your documentation process more collaborative with change requests How to encourage contributions to your open source documentation Developers Developer documentation Quickstart Install the CLI CLI reference Configure your integration Develop your integration ContentKit Component reference Markdown Integration runtime Client library GitBook methods Publish your integration Submit your integration for review Concepts Guides Create a custom unfurl action Create interactive blocks Receive webhook notifications Work with HTTP requests Quickstart API reference Organizations Organization members List all organization members Get an organization member by its ID Delete an organization member Update an organization member Update an organization member last seen at Set a user as an SSO member of an organization List an organization member space permissions List all organization member teams Organization invites Invite users in an organization Join an organization with an invite List organization invites Create an organization invite Get an organization by its ID Update an organization invite Organization AI ask Ask a question in an organization List recommended questions to ask in an organization List recommended questions to ask in an organization (streamed) Ask a question in an organization (streamed) Get the list of organizations for the currently authenticated user Get an organization by its ID Update an organization List all styleguides in an organization List all built-in styleguide templates Deletes an organization invite. Join an organization Search content in an organization Get Docs agent instructions for an organization Update Docs agent instructions for an organization Get all organizations by email domain Docs sites Site share links List all private share links for a site Create a private share link for a site Deletes a share link Update a private share link for a site Site structure Get the full navigation structure of a site Site auth Get the published content authentication configuration for a site Update the published content authentication configuration for a site Regenerate the private key for a site's published content authentication Site preview Generate a temporary preview URL for a site's published content Site customization Get the branding and visual customization settings for a site Update the branding and visual customization settings for a site Get the customization overrides for a site space Delete a site space customization settings Override branding and customization settings for a specific site space Site agent settings Get the AI agent configuration for a site Update the AI agent configuration for a site Site spaces List all spaces linked to a site as content sources Add a space to a site as a content source Delete a site space Update a space linked to a site Move a site space to a new position. (Deprecated) use sortSiteStructure instead. Site sections List all navigation sections in a site Add a new navigation section to a site backed by a space Delete a site section Update a navigation section in a site Move a site section to a new position. (Deprecated) use sortSiteStructure instead. Site section groups List all section groups in a site's navigation structure Add a section group to a site's navigation structure Delete a site section group Update a section group in a site's navigation structure Move a site section group to a new position. (Deprecated) use sortSiteStructure instead. Site redirects List all URL redirect rules configured for a site Create a URL redirect rule for a site Create, update, delete, or publish site redirect rules in bulk Delete a site redirect Update a URL redirect rule for a site Resolve a site redirect rule by its source path Site MCP servers List all MCP servers configured for a site Add a new MCP server configuration to a site Get an MCP server configuration for a site by its ID Delete a site MCP server Update an MCP server configuration for a site Site channels List all GitBook Agent channels for a site Create a new GitBook Agent channel for a site Get a GitBook Agent channel for a site by its ID Delete a GitBook Agent channel from a site Update a GitBook Agent channel for a site Site ads Update the advertising settings for a site List all the sites with ads configured Update the Ads configuration for a site Site permissions Invite a user or a team to a site List an org team's permission in a site Remove an org team from a site Update an org team's permission in a site Site insights Track site events Query a site's analytics events List a site visitor segments Site AI Generate an AI response in a site Site AI ask Ask a question in a site List recommended questions to ask in a site Site context List all context records Create or update context records Get a context record List all site scans Enqueue a new site scan Get a site scan by ID List all site context findings Get a site finding by ID Update a site finding List change requests linked to a site finding Process a site finding into change requests List pages linked to a site finding List questions linked to a site finding List records linked to a site finding List all context connections Create a context connection Get a context connection Delete a context connection Update a context connection Trigger a sync for a context connection Test a context connection's stored credentials List all topics Get a topic Update a topic Delete all findings for a topic Site questions List the questions visitors asked a site's Ask AI assistant Get a single Ask AI question by ID List the documentation sources used to answer a question Get aggregate Ask AI question statistics for a site List the answers a site's Ask AI assistant generated Get a single Ask AI answer by ID Get the conversation thread for an Ask AI answer List the documentation sources cited for an answer List all documentation sites in an organization Create a new documentation site in an organization Get a documentation site by its ID Delete a site Update the properties of a documentation site Get the visitor attributes JSON schema for an adaptive content site Update the visitor attributes JSON schema for an adaptive content site List condition templates for adaptive content expressions in a site Get the full published profile of a site including structure and customization Publish a site to make it publicly accessible Take a site offline by unpublishing it Move a site space, section, or section group to a new position Full-text search across all content in a site Create or retrieve the styleguide space for a site Collections Collection permissions Invite to a collection List an org team's permission in collection Remove an org team from a collection Update an org team's permission in a collection List collection user permissions Remove a user from a collection Update a collection user permission Get a collection by its ID Delete a collection Update a collection List all collection spaces Move a collection to a new position. Transfer a collection List all collections Create a collection Spaces Space content Full-text search across all pages in a space Get the current published content revision of a space Apply a content template to populate a space with initial pages List all pages in a space with their hierarchy and metadata List all uploaded files and assets in a space Get a specific uploaded file from a space by its ID Get a single page from a space by its ID Get navigation metadata links for a page (previous, next, parent) Get a page from a space by its URL path Get a reusable content block from a space by its ID Compute and render a document from a structured content source Compute and render a full revision from a structured content source Get a raw document from a space by its document ID Get a specific historical revision of a space Get semantic content changes introduced by a revision List all pages in a specific historical revision of a space List all files (images, assets) in a specific space revision Get a specific file from a space revision by its file ID Get a page from a specific historical revision by its page ID Get the raw document body of a page in a historical revision Get a page from a specific historical revision by its URL path List all meta links (prev/next navigation) for a page in a revision Get a reusable content block from a historical revision by its ID Get the document body of a reusable content block in a historical revision Get a temporary URL to download a space or page as PDF Space comments List all top-level comments posted on a space Post a new comment on a space or a specific page Get a single comment from a space by its ID Update the body or status of a space comment Delete a space comment Post a reply to an existing space comment Get a single reply to a space comment by its ID Update the body of a reply to a space comment Delete a space comment reply List all users who have posted comments in a space Space embeds Resolve a URL to an oEmbed object within a space Space permissions Invite a user or a team to a space Remove an org team from a space Update an org team's permission in a space List space user permissions Remove a space user Update space user permissions List an org team's permission in a space List all space users permissions List all collections users permissions Space integrations List all third-party integrations enabled on a space List all custom content blocks provided by integrations in a space Git Pull content into a space from a connected Git repository Push space content to a connected Git repository Get the Git Sync configuration and status for a space Remove the legacy Git Sync installation from the space to be able to upgrade it to use the new Git integrations Get full details of a space by its ID Delete a space Update a space's title, icon, or settings Create a full copy of a space Restore a recently deleted space from the trash Move a space to a different collection or position List all spaces in an organization Create a new documentation space in an organization Change requests Change request content Get the latest content revision of a change request Apply a batch of content changes to a change request List all pages in a change request as a flat list List all files (images/attachments) in a change request Get a specific file in a change request by its ID Get a page in a change request by its ID Get navigation meta-links (prev/next/parent) for a change request page Get a reusable content block in a change request by its ID List semantic content changes in a change request vs its base Get a page in a change request by its URL path Change request contributors List all users who have made edits to a change request Change request reviewers List all users requested to review a change request Send review requests to users for a change request Remove a reviewer from a change request Change request comments List all top-level comments in a change request Post a new comment on a change request Get a single comment from a change request by its ID Update the content or status of a change request comment Delete a change request comment List all replies to a change request comment Post a reply to a change request comment Get a single reply to a change request comment Update the content of a change request comment reply Delete a change request comment reply List all users who have commented in a change request List all change requests for a space Create a new change request in a space Get a change request by its ID Update a change request's subject, description, or status Merge a change request into the space's live content Sync a change request with the latest live space content Get a temporary URL to download a change request's content as PDF List all change requests across an entire organization Translations Glossary List glossary entries Update glossary entries Get a glossary entry by its ID List all the translations Create a translation Get a translation by its ID Update a translation Delete a translation Run a translation again Imports Import content into a space from a website Cancel an import run Integrations List all public integrations Get an integration by its name Publish an integration Unpublish an integration List all integration installations Install an integration List all integration events Get an integration event by its ID List all integration space installations List all integration site installations Enable integration dev mode Disable integration dev mode Render an integration UI with GET method Render an integration UI with POST method Queue an integration task Get an integration installation by its ID Uninstall an integration Update an integration installation Create an integration installation API token List all space integration installations Get an integration space installation Uninstall an integration from a space Update an integration space installation List all site integration installations Install an integration on a site Get an integration site installation Uninstall an integration from a site Update an integration site installation List all public integrations along with private ones trusted by the specific org. Get the status of an integration List all integration installations List all integration statuses List custom scripts injected into a site's published pages List third-party integrations enabled on a site URLs Resolve a URL to a content (space, collection, page) Resolve a URL to an embed Resolve a URL of a published content. Resolve a URL of a published content. OpenAPI OpenAPI spec versions List all OpenAPI spec versions Get the latest OpenAPI spec version Get the latest OpenAPI spec version content Get the raw content of the latest OpenAPI spec version Get an OpenAPI spec version by its ID Get an OpenAPI spec version content by its ID List all OpenAPI spec Create an OpenAPI spec Get an OpenAPI spec by its slug Create or update an OpenAPI spec Delete an OpenAPI spec Update OpenAPI spec visibility Custom fonts List all custom fonts Create a custom font Get a custom font by its ID Update a custom font Delete a custom font Subdomains Get a subdomain Users Get profile of authenticated user Create a JWT to access the in-app notifications service Get a user by its ID Update a user by its ID Teams Team members List all team members Updates members of a team Add a team member Delete a team member List all teams Create a team Get a team Delete a team Update a team SSO List all SAML providers Create a new SAML provider Get a SAML provider by its ID Delete a SAML provider Update a SAML provider List all SSO provider login infos Storage Create a signed URL to upload a file Custom hostnames Get a custom hostname Remove a custom hostname Revalidate a custom hostname DNS System info Get API information GitBook API Install an integration on a space Authentication Rate limiting Pagination Errors Concepts Guides Changelog Product updates 2025 2024 2023 2022 and earlier Help Center Help Center What does GitBook’s trial include? Managing your account Sign up and login issues Why I am not receiving emails from GitBook? Why I am not receiving notifications? Organization management Changing organization ownership What happens to my content if an account or organization is deleted? Managing user access and related charges Pricing, plans and billing Do I have to pay to publish a site? Which payment methods do you accept? Where can I find my invoices, and update billing details? I was charged for an unexpected upgrade I have paid for the yearly plan. Why did I receive another invoice? Why don’t I get billed for the Advanced AI Assistant or Translation add-ons flat fees immediately? Do you offer a free plan for non-profits and open-source organizations? Do you offer any discounts? Can I get a refund? Editing Moving your content Assets and files Publishing How can I publish a space? How to preview a docs site? How do I unpublish a site? How can I publish a site with multiple versions? How to set the home for a site or section? What happens to my site when I delete a space connected to it? Why is my space still indexed in search engines after I unpublished it? Why is my site still accessible after deleting/unpublishing? How does GitBook handle SEO? Customization What’s the recommended page cover image size? How do I change or replace the favicon for my docs site? Can I edit HTML, CSS, JS, or other custom code on GitBook? Can I remove "Powered by GitBook" on a paid plan? Custom domains My custom subdomain isn't working Change or update my custom domain in GitBook How can I solve the "path is already taken" error? How can I change the slug in the URL? Adaptive content Which authentication method should I use for Adaptive content? Can I publish a site with only some content requiring authentication? Why my Adaptive Content segments aren't working or showing in preview? How do I set up Adaptive content with my custom OIDC provider? Limitations and troubleshooting Site Insights How can I access insights or analytics? Why is my Site insights data not loading? What does “Page not found” mean in insights? What does "Not set" means in referrer insights? Can I request an integration? Can I build my own integration? Does GitBook have a CLI tool? How do I install an integration on my site? Does GitBook support Google Tag Manager? Integrations troubleshooting I can't find where to put my Google Analytics tracking ID Why am I seeing “We couldn’t load the integration” in GitBook? Why is the Mermaid block not loading? Git Sync Does Git Sync also sync pull-requests? Why am I getting a Git authentication failed message? Git Sync status shows an unexpected error ​GitBook is not using my docs folder GitBook is creating new markdown files ​Nothing happens on GitBook after adding a new file to my repository My table of contents is not correctly structured Error when pushing to the repository with protected branch Git Sync file size limitations Where can I find API ids? Resolving "Connection Lost" message How do I contact support? How do I generate a HAR file? How do I hard refresh my browser? How can I contribute to GitBook’s Documentation? Policies Site Policy on GitBook Terms of Service DMCA Takedown Policy Guide to Submitting a DMCA Takedown Notice Guide to Submitting a DMCA Counter Notice Name Squatting Policy Trademark Policy Private Spaces Security Reporting bugs and vulnerabilities Subprocessors Security FAQ AI Policy Security as a company value Privacy Statement Cookies Querying This Documentation ## What is GitBook Documentation's llms.txt? GitBook Documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what GitBook Documentation offers and where to find details. Issues Spec 7 Sections 719 Links 121.9 KB Size ~31.2k Tokens Sections: Documentation · Guides · Developers · Changelog · Help Center · Policies · and 1 more ## Add GitBook Documentation Docs to Your AI Assistant Select your tool to see how to add GitBook Documentation's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://gitbook.com/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about GitBook Documentation Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 1 error ## Frequently Asked Questions Where is GitBook Documentation's llms.txt file? GitBook Documentation publishes its llms.txt at https://gitbook.com/llms.txt. This file provides a structured, markdown-formatted index of GitBook Documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use GitBook Documentation's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of GitBook Documentation's documentation so it can provide better code suggestions and answers about GitBook Documentation. What does GitBook Documentation's llms.txt contain? GitBook Documentation's llms.txt contains 7 sections and 719 documentation links in 121.9 KB (~31.2k tokens). Key sections include Documentation, Guides, Developers, Changelog, Help Center, Policies. How many tokens does GitBook Documentation's llms.txt use? The concise llms.txt index is approximately 31.2k tokens (121.9 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Nx Nx is an AI-first monorepo platform that connects your editor to CI. It helps you deliver fast without breaking things by optimizing builds, scaling CI, and fixing failed PRs.](https://mdream.dev/llms-txt/gitbook/llms-txt/nx) [Appwrite Appwrite® - complete cloud infrastructure for your web, mobile and AI apps. Including Auth, Databases, Storage, Functions, Messaging, Hosting, Realtime and more](https://mdream.dev/llms-txt/gitbook/llms-txt/appwrite) [EventCatalog EventCatalog is an Open Source project that helps you document your messages, services and domains.](https://mdream.dev/llms-txt/gitbook/llms-txt/eventcatalog) [Prefect](https://mdream.dev/llms-txt/gitbook/llms-txt/prefect) [Knock Documentation](https://mdream.dev/llms-txt/gitbook/llms-txt/knock) [Add a New Provider In above example, we have given our provider name as example-provider for simplicity. If provider you want to add have name as twilio, don't use twilio-provider as name, instead use twilio only. If one provider supports multiple channels like infobip supports both sms and email channels, use infobip-email or infobip-sms to differentiate these providers.](https://mdream.dev/llms-txt/gitbook/llms-txt/novu) [Tamagui Complete Documentation Tamagui is a complete UI solution for React Native and Web, with a fully-featured UI kit, styling engine, and optimizing compiler.](https://mdream.dev/llms-txt/gitbook/llms-txt/tamagui) [Apify Documentation The entire content of Apify documentation is available in a single Markdown file at https://docs.apify.com/llms-full.txt](https://mdream.dev/llms-txt/gitbook/llms-txt/apify) [View all 99 projects ](https://mdream.dev/llms-txt/gitbook/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/gitbook/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/gitbook/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)