# Gitbook > We've worked on GitBook's overall editor experience, improving reliability, copy/paste from multiple sources and speedy shortcuts. ## Pages - [2022 and earlier](2022-and-earlier-product-updates.md): {% updates format="full" %} - [2023](2023-product-updates.md): {% updates format="full" %} - [2024](2024-product-updates.md): {% updates format="full" %} - [2025](2025-product-updates.md): {% updates format="full" %} - [7 ways to make your public documentation more useful for users](7-ways-to-make-your-public-documentation-more-useful-for-users.md): Documentation is only useful if it’s up to date and people can find it. And when it comes specifically to public user... - [Personal settings](account-settings.md): You can manage your login details, third-party login options, GitBook subdomain, interface theme, notification, integ... - [Adapting your content](adapting-your-content.md): After setting up your authentication method, you’ll be able to use the data to adapt the content in your site for dif... - [Adaptive content](adaptive-content.md): {% hint style="info" %} - [Add an OpenAPI specification](add-an-openapi-specification.md): If you have an OpenAPI spec, you can add it to your organization by uploading the file directly, linking to a hosted ... - [Adding custom code samples](adding-custom-code-samples.md): GitBook can automatically generate generic code examples for each API operation. If you’d prefer to showcase custom o... - [AI 编码助手和 skill.md](ai-bian-ma-zhu-shou-he-skillmd.md): GitBook 提供了一个 [skill.md](https://gitbook.com/docs/skill.md) 文件，教会 AI 编码助手如何正确编辑 GitBook 文档。在本地编辑 GitBook 文档时，将其作为“项目规... - [AI coding assistants and skill.md](ai-coding-assistants-and-skillmd.md): GitBook provides a [skill.md](https://gitbook.com/docs/skill.md) file that teaches AI coding assistants how to proper... - [AI-native documentation](ai-documentation.md): Documentation hosted on GitBook benefits from built-in AI features and optimizations out of the box. - [AI コーディングアシスタントと skill.md](ai-kdinguashisutantoto-skillmd.md): GitBook は [skill.md](https://gitbook.com/docs/skill.md) ファイルを提供しており、AI コーディングアシスタントに GitBook ドキュメントを適切に編集する方法を教えます。ロー... - [AI Policy](ai-policy.md): At GitBook, we leverage artificial intelligence to enhance our product with features powered by OpenAI. We are commit... - [AI Search](ai-search.md): Help your users find the information they need faster with powerful knowledge discovery tools for your published content - [Analyze change request contributors with GitBook’s API](analyze-change-request-contributors-with-gitbooks-api.md): GitBook’s API makes it possible to track change request creators, reviewers, and contributors across all your spaces. - [API docs: The seven principles of great API docs and how to apply them](api-documentation-principles.md): How important is API documentation? - [API reference](api-reference.md): The GitBook API provides developers with a powerful and flexible way to interact with GitBook's platform programmatic... - [Assets and files](assets-and-files.md): We don’t have a set limit for the total number of assets in a space, but we reserve the right to block your account i... - [Assistants de codage IA et skill.md](assistants-de-codage-ia-et-skillmd.md): GitBook fournit un [skill.md](https://gitbook.com/docs/skill.md) fichier qui apprend aux assistants de codage IA comm... - [Authenticated access](authenticated-access.md): {% hint style="info" %} - [Authentication](authentication.md): The GitBook API uses personal access tokens to authenticate requests. - [Automatic documentation suggestions](automatic-documentation-suggestions.md): {% hint style="info" %} - [变更请求界面](bian-geng-qing-qiu-jie-mian.md): GitBook 的变更请求界面可以轻松查看和管理组织中的活动变更请求。 - [Billing policy](billing-policy.md): Our billing process is structured to align charges with the level of plan usage: - [Blocks](blocks.md): GitBook is a block-based editor, meaning you can add different kinds of blocks to your content — from standard text a... - [Can I build my own integration?](can-i-build-my-own-integration.md): Our integration platform is currently available to anyone with a GitBook account! Head to [our integrations page](htt... - [Can I edit HTML, CSS, JS, or other custom code on GitBook?](can-i-edit-html-css-js-or-other-custom-code-on-gitbook.md): GitBook does not directly support editing HTML, CSS, JavaScript, or any other custom code within its platform. - [Can I get a refund?](can-i-get-a-refund.md): As per our [Terms of service](https://gitbook.com/docs/policies/terms) - we do not offer refunds. - [Can I publish a site with only some content requiring authentication?](can-i-publish-a-site-with-only-some-content-requiring-authentication.md): Yes! You can have a public site with some authenticated sections using Adaptive Content without requiring login for t... - [Can I request an integration?](can-i-request-an-integration.md): Yes! You can [submit an integration request using this form](https://survey.refiner.io/e61q1m-dp057m). Additionally, ... - [Subscription cancellations](cancelling-a-plan.md): If you’re thinking about cancelling a plan because you’re running into any issues while using GitBook, please [contac... - [Cards](cards.md): You can use cards to create a visually pleasing page layout, combining text and images in a grid. They’re ideal for b... - [Change or update my custom domain in GitBook](change-or-update-my-custom-domain-in-gitbook.md): You can easily update your custom domain through your site settings: - [Change request comments](change-request-comments.md): This API powers the inline discussion around any new or updated documentation. Participate in comment threads and res... - [Change request content](change-request-content.md): Retrieve or update the pages and files tied to an open change request. This lets you preview alterations and merge th... - [Change request contributors](change-request-contributors.md): Quickly access the full list of collaborators and their contributions within a change request for better traceability... - [Change request reviewers](change-request-reviewers.md): Ensure quality by requesting and tracking reviewer feedback in your GitBook flow. This endpoint helps orchestrate the... - [Change requests in a space](change-requests-in-a-space.md): When you’re within a [space](https://gitbook.com/docs/getting-started/concepts#space), you can make changes by openin... - [Change requests screen](change-requests-screen.md): The change requests screen in GitBook makes it easy to view and manage active change requests in your organization. - [Change requests](change-requests.md): A change request is a copy of your main content. It comes from the simple concept of [**branching**](https://git-scm.... - [Changing organization ownership](changing-organization-ownership.md): If you would like to change the email that your GitBook account is registered to, please navigate to your organizatio... - [CLI reference](cli-reference.md): Authenticate the CLI with a GitBook Developer API token. You can generate a personal developer token in your [GitBook... - [Client library](client-library.md): GitBook provides an official TypeScript/JavaScript client for the [HTTP API](https://gitbook.com/docs/developers/gitb... - [Code blocks](code-block.md): You can add code to your GitBook pages using code blocks. - [Collection teams](collection-teams.md): Assign entire teams to a collection for easier role and permission management. Perfect for larger organizations looki... - [Collection users](collection-users.md): Control which users have access to a collection's spaces. This ensures only the right individuals can view or modify ... - [Collections](collection.md): Collections are a way to group spaces together to make it easier for you to organize your content. With collections, ... - [Collections](collections.md): Collections let you bundle multiple spaces under a unified entity, making large-scale content easier to handle. You c... - [Columns](columns.md): Columns are a great way to create different layouts for your documentation. You can add many different types of block... - [Combine multiple existing sites into one using site sections](combine-multiple-docs-sites-using-sections.md): With [site sections](https://app.gitbook.com/s/NkEGS7hzeqa35sMXQZ4X/publishing-documentation/site-structure/site-sect... - [Comments](comments.md): Comments allow you to provide feedback around specific pieces of content — without switching out of context from GitB... - [Commit messages & Autolink](commits.md): By default, when exporting content from GitBook to the Git repository, GitBook will generate a commit message based o... - [Community plan](community.md): We welcome applications for our community plan from organizations that meet certain criteria. Broadly, these fall int... - [Concepts](concepts.md): A space is a project that lets you work on a collection of related pages. Within a space you can write content, organ... - [Conditional content](conditional-content.md): Conditional content blocks let you control who can see a given block of content on your page based on user data and v... - [Configuration](configuration.md): - [Customizing the Embed](/docs/publishing-documentation/embedding/configuration/customizing-docs-embed.md): Customiz... - [Configure your integration](configurations.md): Integrations are defined through a file called`gitbook-manifest.yaml`. This file is automatically created through th... - [Configuring a subdirectory with AWS using CloudFront and Route 53](configuring-a-subdirectory-with-aws.md): {% hint style="info" %} - [Configuring a subdirectory with Cloudflare](configuring-a-subdirectory-with-cloudflare.md): {% hint style="info" %} - [Configuring a subdirectory with Vercel](configuring-a-subdirectory-with-vercel.md): {% hint style="info" %} - [Configuring the “Test it” button](configuring-the-test-it-button.md): You can configure the "Test It" button and accompanying window in GitBook using several OpenAPI extensions. These ext... - [Connecting a source](connecting-a-source.md): GitBook Agent can pull in context from different sources, including Intercom, Slack, email, and more. Connecting a so... - [Connexion d'une source](connexion-dune-source.md): GitBook Agent peut intégrer du contexte provenant de différentes sources, notamment Intercom, Slack, e‑mail et plus e... - [Content configuration](content-configuration.md): If you’d like to configure Git Sync further, you can add a`.gitbook.yaml`file at the root of your repository to tel... - [Content structure](content-structure.md): The structure of your content in GitBook is organized through pages, spaces and collections. Pages live inside of spa... - [ContentKit](contentkit.md): ContentKit is a UI framework allows you to build integrations that work from directly within GitBook. It is used to d... - [Conversations](conversations.md): The Conversations endpoints let you ingest, manage, and monitor Conversations in GitBook to be processed by Docs Agents. - [Cookies](cookies.md): {% hint style="info" %} - [Create a custom unfurl action](create-a-custom-unfurl-action-for-your-integration.md): Link unfurling refers to the automatic previewing of website links shared in online platforms—Like chat applications,... - [Creating custom tools](creating-custom-tools.md): Custom tools in the Docs Embed allow you to let the Assistant intelligently dispatch actions in your product or on th... - [Set a custom domain](custom-domain.md): {% hint style="info" %} - [Custom domains](custom-domains.md): - [My custom subdomain isn't working](/docs/help-center/published-documentation/custom-domains/my-custom-subdomain-is... - [Custom fonts](custom-fonts.md): Upload and manage custom fonts for branding or aesthetic purposes. Once added, fonts can be applied to your spaces or... - [Custom hostnames](custom-hostnames.md): Extend your brand identity by mapping personalized domain names to your docs. This can help unify your documentation ... - [Site customization](customization.md): {% hint style="info" %} - [Customizing the Embed](customizing-docs-embed.md): After [adding Docs Embed to your website or app](https://gitbook.com/docs/publishing-documentation/embedding/implemen... - [Demandes de modification dans un espace](demandes-de-modification-dans-un-espace.md): Lorsque vous êtes dans un [espace](https://gitbook.com/docs/documentation/fr/getting-started/concepts#space), vous po... - [Describing enums](describing-enums.md): When an API operation includes an enum, you can add`x-enumDescriptions`to provide more context about each option. G... - [Develop your integration](development.md): After [bootstrapping your integration with the GitBook CLI](https://gitbook.com/docs/developers/quickstart#bootstrap-... - [DMCA Takedown Policy](dmca-takedown-policy.md): Welcome to GitBook's Guide to the Digital Millennium Copyright Act, commonly known as the "DMCA." This page is not me... - [Do I have to pay to publish a site?](do-i-have-to-pay-to-publish-a-site.md): We offer unlimited basic sites for free, however, if you are planning to use custom domains, advanced customizations ... - [Do you offer any discounts?](do-you-offer-any-discounts.md): You can get 2 months free by subscribing to our annual plan! - [Docs sites](docs-sites.md): The Docs Sites API lets you programmatically manage published documentation sites within your organization. You can l... - [Document your API in GitBook in 5 simple steps](document-your-api-in-gitbook-in-5-simple-steps.md): This comprehensive guide will walk you through the process of documenting your API in GitBook, from initial setup to ... - [Documentation analytics: which metrics to track and how to measure success](documentation-analytics.md): “How do you know if your documentation is successful?” - [Build your docs around your users’ needs with documentation personas](documentation-personas.md): The first step to great product documentation is to know your reader. What do they want to achieve? What context and ... - [How to structure technical documentation: information architecture best practices](documentation-structure-tips.md): {% hint style="info" %} - [Does Git Sync also sync pull-requests?](does-git-sync-also-sync-pull-requests.md): No, our integration with both GitLab and GitHub don't sync pull-requests (PRs). This means that if you create a PR in... - [Does GitBook have a CLI tool?](does-gitbook-have-a-cli-tool.md): GitBook only offers a CLI tool to build and update integrations. See our [developer documentation](https://app.gitboo... - [Do you offer a free plan for non-profits and open-source organizations?](does-gitbook-offer-a-free-plan-for-non-profit-open-source-organizations.md): We welcome applications for our free community plan from organizations that meet certain criteria. - [Does GitBook support Google Tag Manager?](does-gitbook-support-google-tag-manager.md): No, GitBook does not integrate with Google Tag Manager. This is because it allows the injection of CSS/JS, which can ... - [Drawings](drawing.md): You can create a drawing or sketch directly though GitBook using the integrated [Excalidraw](https://excalidraw.com/)... - [Écran des demandes de modification](ecran-des-demandes-de-modification.md): L’écran des demandes de modification dans GitBook permet de visualiser et de gérer facilement les demandes de modific... - [Embedded URLs](embed-a-url.md): To add an embedbed URL, simply paste the link of the content you want to embed and hit`Enter`. - [Embed in your product](embedding.md): The Docs Embed is a powerful window into your product knowledge that you can add to any product or website. Users can... - [Enabling adaptive content](enabling-adaptive-content.md): To start customizing your documentation experience for your readers, you'll need to enable adaptive content and decid... - [Enabling authenticated access](enabling-authenticated-access.md): To protect your docs behind a sign-in screen, you’ll need to first enable authenticated access for your site. - [Enabling GitHub Sync](enabling-github-sync.md): In the space you want to sync with your GitHub repo, head to the [space header](https://gitbook.com/docs/resources/gi... - [Enabling GitLab Sync](enabling-gitlab-sync.md): In the space you want to sync with your GitLab repo, head to the space menu in the top right, and select **Synchroniz... - [Error when pushing to the repository with protected branch](error-when-pushing-to-the-repository-with-protected-branch.md): This error occurs when your Git branch is protected. - [Errors](errors.md): GitBook uses conventional HTTP response codes to indicate the success or failure of an API request. As a general rule: - [Expandable](expandable.md): Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-... - [Explorer vos données](explorer-vos-donnees.md): Une fois que GitBook Agent commence à ingérer des conversations, il commencera à classer vos données en trois catégor... - [Exploring your data](exploring-your-data.md): Once GitBook Agent starts ingesting conversations, it will start to categorize your data into three categories: - [Extensions reference](extensions-reference.md): You can enhance your OpenAPI specification using extensions—custom fields that start with the`x-`prefix. These exte... - [Extra configuration](extra-configuration.md): In the **Configuration** tab you can change other settings associated with your site. For example, you can set up int... - [Feature flags](feature-flags.md): {% hint style="warning" %} - [Find & replace or make batch changes across your GitBook docs with Git Sync](find-and-replace-or-make-batch-changes-across-your-gitbook-docs-with-git-sync.md): {% hint style="warning" %} - [Formatting your content](formatting.md): To format your text, simply select the words you want and choose one of the formats from the context menu — or format... - [GEO guide: How to optimize your docs for AI search and LLM ingestion](geo-guide-how-to-optimize-your-docs-for-ai-search-and-llm-ingestion.md): Have you optimized your documentation for AI? - [GEO guide: How to optimize your docs for AI search and LLM ingestion](geo-guide.md): This guide lays out the best practices to optimize your docs for AI. So your product is mentioned cited and explained... - [Git Sync file size limitations](git-sync-file-size-limitations.md): Git Sync limits individual file sizes to a maximum of 100MB. - [Git Sync status shows an unexpected error](git-sync-status-shows-an-unexpected-error.md): Please try creating a new change request in GitBook with a small change, such as adding a word or space somewhere in ... - [GitHub & GitLab Sync](git-sync.md): Git Sync allows technical teams to synchronize GitHub or GitLab repositories with GitBook and turn Markdown files int... - [Git](git.md): Manage the linkage between your GitBook space and external Git repositories, enabling commits, merges, and pull reque... - [GitBook Assistant](gitbook-ai-assistant.md): {% hint style="info" %} - [GitBook AI](gitbook-ai.md): When engaging with GitBook AI, you have the ability to ask questions or elaborate on specific requirements. This AI-d... - [GitBook is creating new markdown files](gitbook-is-creating-new-markdown-files.md): **When synchronizing and editing from GitBook** with an existing Git repository, GitBook may create new markdown file... - [​GitBook is not using my docs folder](gitbook-is-not-using-my-docs-folder.md): By default, GitBook uses the repository's root as a starting point. A specific directory can be specified to scope th... - [GitBook methods](gitbook-methods.md): The following methods can be found on the`client.search`object. - [GitBook UI](gitbook-ui.md): GitBook is split into different sections to make it easier to organize and manage the content you create. - [GitHub pull request preview](github-pull-request-preview.md): When you submit a pull request (PR) to a GitHub branch that has been synced to a GitBook space, you can preview the c... - [Glossary](glossary.md): **Actions menu:** The menu that opens when you click the three dots next to a page or item in the GitBook interface. ... - [共享与社交](gong-xiang-yu-she-jiao.md): 您可以在自定义菜单的元数据和页脚中添加社交账户，方法是从 **共享** 选项卡进入自定义菜单。 - [Guide to Submitting a DMCA Counter Notice](guide-to-submitting-a-dmca-counter-notice.md): This guide describes the information that GitBook needs in order to process a counter notice to a DMCA takedown reque... - [Guide to Submitting a DMCA Takedown Notice](guide-to-submitting-a-dmca-takedown-notice.md): This guide describes the information that GitBook needs in order to process a DMCA takedown request. If you have more... - [Guides](guides.md): - [Structuring your API reference](/docs/api-references/guides/structuring-your-api-reference.md): Learn how to struc... - [Headings](heading.md): Headings help give your documents structure — and using keywords in headings will also help search engines understand... - [Hints](hint.md): Hints, or callouts, are a great way to bring the reader’s attention to specific elements in your documentation, such ... - [How can I access insights or analytics?](how-can-i-access-insights-or-analytics.md): To access your Docs site's insights, navigate to your chosen Docs site and scroll down to the **Insights** in the das... - [How can I change the slug in the URL?](how-can-i-change-the-slug-in-the-url.md): In URLs, a **slug** is the part that comes after the final slash, identifying a specific page in a readable and SEO-f... - [How can I contribute to GitBook’s Documentation?](how-can-i-contribute-to-gitbooks-documentation.md): Thank you for investing your time in contributing to our documentation! Any contribution you make will be reviewed by... - [How can I publish a site with multiple versions?](how-can-i-publish-a-site-with-multiple-versions.md): Multivariant content allows you to display different versions (or variants) of your documentation, for example, diffe... - [How can I publish a space?](how-can-i-publish-a-space.md): As of May 2024, spaces are now being published as part of a docs site and are not published in a standalone fashion a... - [How can I solve the "path is already taken" error?](how-can-i-solve-the-path-is-already-taken-error.md): In GitBook, each slug is designed to be unique within the context of your **entire organization**. This means that ea... - [How do I change or replace the favicon for my docs site?](how-do-i-change-or-replace-the-favicon-for-my-docs-site.md): To replace the favicon for your published docs site, head to the site’s dashboard, then click the **Customization** t... - [How do I contact support?](how-do-i-contact-support.md): There are two ways to get in touch with us: - [How do I generate a HAR file?](how-do-i-generate-a-har-file.md): A **HAR capture** (HTTP Archives) records your browser's requests and responses with the GitBook Application, allowin... - [How do I hard refresh my browser?](how-do-i-hard-refresh-my-browser.md): Our support team might ask you to ***hard*** refresh your browser as part of the troubleshooting process. This is dif... - [How do I install an integration on my site?](how-do-i-install-an-integration-on-my-site.md): To make the distinction between internal content and published content for external readers, we have moved all the ac... - [How do I set up Adaptive content with my custom OIDC provider?](how-do-i-set-up-adaptive-content-with-my-custom-oidc-provider.md): Adaptive content works with any identity provider - [How does GitBook handle SEO?](how-does-gitbook-handle-seo.md): Thanks to the following features, your GitBook projects are SEO-friendly with little or no configuration on your end: - [How to create branded documentation](how-to-create-branded-documentation.md): Adding your brand’s identity to documentation is a great way to make your docs site feel like part of your product. A... - [How to encourage contributions to your open source documentation](how-to-encourage-contributions-to-your-open-source-documentation.md): For many people coming across your open source project, your docs are the first port of call when they’re trying to w... - [How to handle merge conflicts in GitBook](how-to-handle-merge-conflicts-in-gitbook.md): Merge conflicts in GitBook occur when changes in a [change request](https://app.gitbook.com/s/NkEGS7hzeqa35sMXQZ4X/co... - [How to personalize your GitBook site using Auth0 and adaptive content](how-to-personalize-your-gitbook-site-using-auth0-and-adaptive-content.md): {% hint style="info" %} - [How to personalize your GitBook site using URL parameters and adaptive content](how-to-personalize-your-gitbook-site-using-url-parameters-and-adaptive-content.md): {% hint style="info" %} - [How to preview a docs site?](how-to-preview-a-docs-site.md): The **Preview** feature allows you to see what your published content looks like before publishing it to all readers. - [How to unpublish a site?](how-to-unpublish-a-site.md): You can unpublish an entire site or remove a linked space, anytime. This action does not affect your billing. To adju... - [How to use SEO techniques to improve your documentation](how-to-use-seo-techniques-to-improve-your-documentation.md): *Last updated on 28 January, 2026.* - [How to write incredible API documentation](how-to-write-incredible-api-documentation.md): You only get one shot at a first impression. And if you’re building an API product, chances are that first impression... - [I have paid for the yearly plan. Why did I receive another invoice?](i-have-paid-for-the-yearly-plan-why-did-i-receive-another-invoice.md): This happens when you have added extra users since subscribing to an annual plan. Each user (regardless of their perm... - [I was charged for an unexpected upgrade](i-was-charged-for-an-unexpected-upgrade.md): Plan upgrades in GitBook always require user confirmation through a pop-up modal that clearly shows the plan details ... - [Icons, colors, and themes](icons-colors-and-themes.md): You can set any title you choose for your space. Note: this setting will only affect the title that displays *in the ... - [Can I "Powered by GitBook" on a paid plan?](if-i-subscribe-to-a-paid-plan-can-i-remove-the-powered-by-gitbook-badge.md): No, removing the "Powered by GitBook" link is not an option that we provide. - [Implementation](implementation.md): - [Script tag](/docs/publishing-documentation/embedding/implementation/script.md): Add Docs Embed to any website with... - [Import or migrate your content to GitBook with Git Sync](import-or-migrate-your-content-to-gitbook-with-git-sync.md): One of the best ways to import your content into GitBook is using [Git Sync](https://app.gitbook.com/s/NkEGS7hzeqa35s... - [Import content from a CSV file into GitBook](import-zendesk-csv-to-gitbook.md): This guide explains how to import HTML content stored in a CSV file into GitBook. - [Migrate to GitBook](import.md): You can migrate and unify existing documentation in GitBook using the import tool. - [Imports](imports.md): The Imports API provides allows you to import content into GitBook. - [Inline content](inline.md): The inline palette lets you quickly add extra content to your text block without moving your hands away from the keyb... - [Insert API reference in your docs](insert-api-reference-in-your-docs.md): GitBook allows you to automatically generate pages related to the endpoints you have in your OpenAPI spec. These page... - [Files](insert-files.md): You can upload files to your GitBook space and add them to your page for people to view or download. - [Images](insert-images.md): You can insert images into your page, then choose their size and whether to align them to the left, center, or right.... - [Site insights](insights.md): {% hint style="info" %} - [Install and manage integrations](install-an-integration.md): There are [many different integrations](https://app.gitbook.com/integrations) available in GitBook. From interactive ... - [Integrations troubleshooting](integrations-troubleshooting.md): - [I can't find where to put my Google Analytics tracking ID](/docs/help-center/integrations/integrations-troubleshoo... - [Integrations](integrations.md): Expand the capabilities of GitBook by connecting it with various external platforms—CRM, issue trackers, or CI/CD pip... - [Create interactive blocks](interactivity.md): GitBook allows you to create custom, interactive blocks using ContentKit, a UI kit made by GitBook for building integ... - [Introducing AI into your product documentation workflow](introducing-ai-into-your-product-documentation-workflow.md): Product documentation may seem like the ideal job for AI tools such as large language models (LLMs). But if you’ve al... - [Invite or remove members](invite-members-to-your-organization.md): There are a couple of ways you can invite new members to your organization: - [Keyboard shortcuts](keyboard-shortcuts.md): Shortcut keys allow easy and quick methods for navigating or editing content. - [空间内的变更请求](kong-jian-nei-de-bian-geng-qing-qiu.md): 当你在一个 [空间](https://gitbook.com/docs/documentation/zh/getting-started/concepts#space)时，你可以通过打开新的变更请求来进行更改，或浏览现有的变更请求以查... - [Layout and structure](layout-and-structure.md): **Search bar** - [连接数据源](lian-jie-shu-ju-yuan.md): GitBook Agent 可以从不同来源获取上下文，包括 Intercom、Slack、电子邮件等。连接一个来源允许 Agent 根据真实世界的上下文（例如电子邮件链、Slack 线程或已解决的 Intercom 会话）构建变更请求。 - [Limitations and troubleshooting](limitations-and-troubleshooting.md): Search results only reflect the content that a user has access to. Any section, page, or block behind Adaptive Conten... - [Live edits](live-edits.md): With live edits enabled, members in your org can edit a space without creating [a change request](https://gitbook.com... - [LLM-ready docs](llm-ready-docs.md): We’re building features that make it easier for Large Language Models (LLMs) to ingest and work with your documentati... - [Localize your docs with variants in GitBook](localize-your-docs-with-variants-in-gitbook.md): {% hint style="warning" %} - [Make your documentation process more collaborative with change requests](make-your-documentation-process-more-collaborative-with-change-requests.md): Here at GitBook, the [change request workflow](https://app.gitbook.com/s/NkEGS7hzeqa35sMXQZ4X/collaboration/change-re... - [Managing API operations](managing-api-operations.md): It’s common to have operations that are not fully stable yet or that need to be phased out. GitBook supports several ... - [Managing user access and related charges](managing-user-access-and-related-charges.md): GitBook’s pricing is based on the number of members in an organization, and our [pro rata billing policy](https://git... - [Managing your account](managing-your-account.md): - [Sign up and login issues](/docs/help-center/account-management/managing-your-account/sign-up-and-login-issues.md) - [Moving your content](managing-your-content.md): The best way to import content into GitBook is via [GitSync](https://www.gitbook.com/solutions/git-sync). This allows... - [Organization management](managing-your-organization.md): - [Changing organization ownership](/docs/help-center/account-management/managing-your-organization/changing-organiza... - [Markdown](markdown.md): GitBook’s editor allows you to create formatted content using Markdown. - [Site Policy on GitBook](master.md): The universe of policies and procedures that govern the use of GitBook. - [Math & TeX](math-and-tex.md): You can use the mathTeX format to include mathematical formulae in your documentation. We offer this through the [KaT... - [MCP servers for published docs](mcp-servers-for-published-docs.md): Every published GitBook site automatically includes a Model Context Protocol (MCP) server. - [Member management](member-management.md): You can [invite and remove members](https://gitbook.com/docs/account-management/member-management/invite-members-to-y... - [Merge rules](merge-rules.md): {% hint style="info" %} - [Monorepos](monorepos.md): GitBook supports monorepos. A monorepo is a repository that contains more than one logical project (e.g. an iOS clien... - [My custom subdomain isn't working](my-custom-subdomain-isnt-working.md): Custom domain issues are usually DNS-related. Here's how to troubleshoot: - [My table of contents is not correctly structured](my-table-of-contents-is-not-correctly-structured.md): Please ensure that your SUMMARY.md file reflects the structure you want to see in your documentation. - [Name Squatting Policy](name-squatting-policy.md): GitBook account names are provided on a first-come, first-served basis, and are intended for immediate and active use... - [Node.js/NPM](nodejs.md): If you need more control and want to work at the application level, you can install the GitBook embed package from np... - [​Nothing happens on GitBook after adding a new file to my repository](nothing-happens-on-gitbook-after-adding-a-new-file-to-my-repository.md): {% hint style="warning" %} - [Notifications](notifications.md): Notifications provide updates about the activity on GitBook that comes from spaces owned by you or an organization th... - [OpenAPI spec versions](openapi-spec-versions.md): Keep a history of your OpenAPI specs, enabling you to compare different versions, revert, or maintain multiple concur... - [OpenAPI](openapi.md): Manually writing REST API documentation can be a time-consuming process. Fortunately, GitBook streamlines this task b... - [Ordered lists](ordered-list.md): Ordered lists, also called numbered lists, help you prioritize items or create a list of steps. - [Organization AI ask](organization-ai-ask.md): Enhance your team's knowledge base with the Organization AI ask endpoint, which allows you to query AI models trained... - [Organization invites](organization-invites.md): Use this API to create and revoke invitations for new members. By automating invite flows, you can maintain a cohesiv... - [Organization members](organization-members.md): Organization members can be managed through this API, which lets you invite and manage users under a particular organ... - [Organization settings](organization-settings.md): {% hint style="info" %} - [Organizations](organizations.md): The Organizations API provides a robust way to handle the administrative structure of your GitBook workspace. By crea... - [Page links](page-link.md): Page link blocks are the best way create relations between different pages within your content. Page links stand out ... - [Pages](page.md): A page is the place where you can add, edit and embed content. Pages always live inside a [space](https://gitbook.com... - [Pagination](pagination.md): Some methods return paginated results. The formatting of a paginated result is always: - [Paragraphs](paragraph.md): A paragraph is the most basic content block you can use on GitBook. - [Partage et social](partage-et-social.md): Vous pouvez ajouter des comptes sociaux aux métadonnées et au pied de page de votre site depuis le **Partage** onglet... - [PDF export](pdf-export.md): {% hint style="info" %} - [Permissions and inheritance](permissions-and-inheritance.md): GitBook has a flexible permissions model that lets you have as much, or as little, control over permissions as you ne... - [Plans](plans.md): GitBook allows you to publish documentation on different plans. Each site plan contains different features — includin... - [Pricing, plans and billing](pricing-plans-and-billing.md): - [Do I have to pay to publish a site?](/docs/help-center/account-management/pricing-plans-and-billing/do-i-have-to-p... - [Product updates](product-updates.md): {% updates format="full" %} - [Public publishing](public-publishing.md): If you created your docs for a public audience, you can publish it on the web. Spaces that you publish on the web can... - [Publish a docs site](publish-a-docs-site.md): Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site... - [Publish your integration](publishing.md): When you're ready to publish your integration, you're able to publish it for use within GitBook. - [Qu'est-ce que GitBook Agent ?](quest-ce-que-gitbook-agent.md): GitBook Agent est un coéquipier IA qui travaille à vos côtés, vous aidant à garder votre documentation précise, compl... - [Search & Quick find](quick-find.md): GitBook’s **Quick find** palette lets you search for content in your current organization, and jump to pages fast. - [10 quick tips to improve your technical writing workflow in GitBook](quick-tips-to-improve-your-technical-writing-workflow-in-gitbook.md): Your technical documentation probably already contains the right information. Nice work! Now it’s time to make it fas... - [Quickstart](quickstart.md): This quickstart guide explains how to get set up in GitBook and publish your first docs site in minutes. - [Quotes](quote.md): Quotes are useful when you want to include something from another source. - [Rate limiting](rate-limiting.md): Different types of API methods are subject to different rate limits. - [React](react.md): For React projects, GitBook provides prebuilt components that make embedding your docs simple and idiomatic. The comp... - [GitBook documentation](readme.md) - [Work with HTTP requests](receiving-requests.md): Integrations often need to communicate with the outside world — whether that’s receiving webhooks, handling OAuth cal... - [API Reference](reference.md): Docs Embed provides different APIs depending on how you integrate it. This reference covers all available methods acr... - [Reporting bugs and vulnerabilities](reporting-bugs-and-vulnerabilities.md): Occasionally we are contacted about suspected vulnerabilities or security concerns. Please note that we do take those... - [Resolving "Connection Lost" message](resolving-connection-lost-message.md): The "Connection lost" message often indicates that GitBook's necessary network connections are being blocked by your ... - [Reusable content](reusable-content.md): {% hint style="info" %} - [Review change requests with GitBook Agent](review-change-requests-with-gitbook-agent.md): As well as [creating content](https://gitbook.com/docs/gitbook-agent/write-and-edit-with-ai), GitBook Agent can revie... - [Réviser les demandes de modification avec GitBook Agent](reviser-les-demandes-de-modification-avec-gitbook-agent.md): Ainsi que [créer du contenu](https://gitbook.com/docs/documentation/fr/gitbook-agent/write-and-edit-with-ai), GitBook... - [Roles](roles.md): When adding members to your organization, you can give them a **default role**. This role will apply to any content t... - [Integration runtime](runtime.md): GitBook’s integration runtime is the platform that lets you build and run integrations within GitBook. Integrations c... - [Script tag](script.md): The quickest way to add Docs Embed to your website or app is by adding it through a "standalone" script tag. Every do... - [Searching internal content](searching-your-content.md): Whether you’re working within the GitBook app or your visitors are reading your published content, GitBook’s search f... - [Security as a company value](security-as-a-company-value.md): GitBook Inc.’s security & compliance principles guide how we deliver our products and services, enabling our users to... - [Security FAQ](security-faq.md): GitBook is a tech startup, incorporated in the U.S as`GitBook Inc`, with a French subsidiary`GitBook SAS` - [Security](security.md): - [Reporting bugs and vulnerabilities](/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilitie... - [Setting a custom subdirectory](setting-a-custom-subdirectory.md): {% hint style="info" %} - [Setting up a custom backend](setting-up-a-custom-backend.md): {% hint style="warning" %} - [How to personalize your GitBook site using cookies and adaptive content](setting-up-adaptive-content.md): {% hint style="info" %} - [Setting up Auth0](setting-up-auth0.md): {% hint style="info" %} - [Setting up AWS Cognito](setting-up-aws-cognito.md): {% hint style="warning" %} - [Setting up Azure AD](setting-up-azure-ad.md): {% hint style="warning" %} - [Setting up OIDC](setting-up-oidc.md): {% hint style="warning" %} - [Setting up Okta](setting-up-okta.md): {% hint style="warning" %} - [Private publishing with share links](share-links.md): {% hint style="info" %} - [Inviting your team](share.md): To share a space or collection, click the **Share** button in the top-right corner. This will open the share modal. - [Sharing and social](sharing-and-social.md): You can add social accounts to your site’s metadata and footer from the **Sharing** tab in the customization menu. - [什么是 GitBook Agent？](shen-me-shi-gitbook-agent.md): GitBook Agent 是一个 AI 团队成员，与您并肩工作，帮助您保持文档的准确、完整和最新。 - [Sign up and login issues](sign-up-and-login-issues.md): Our platform employs an automatic system designed to block accounts exhibiting suspicious behaviour. This measure is ... - [Site ads](site-ads.md): Manage the advertisement strategy within your docs. You can specify ad placements, track usage, and adjust settings t... - [Site AI ask](site-ai-ask.md): Give your users a way to ask content-aware AI queries that are scoped entirely to the site's published documents. - [Site AI](site-ai.md): Build advanced conversational AI experiences within your docs site that go beyond basic Q\&A. - [Site auth](site-auth.md): Configure the credentials or tokens required to publish documentation externally. This helps ensure your site is cons... - [Site customization](site-customization.md): Update your site's branding, styling, and layout to match your organization's identity. This includes theming element... - [Site insights](site-insights.md): This API delivers insights about how visitors interact with your site, including page views and user engagement, help... - [Site MCP servers](site-mcp-servers.md): Manage Model Context Protocol (Mcp) servers used by your site. - [Site preview](site-preview.md): Quickly generate a preview of how your site's content and layout will appear once published, allowing for final check... - [Site redirects](site-redirects.md): {% hint style="info" %} - [Site section groups](site-section-groups.md): Section groups let you bundle multiple top-level sections together, offering additional structuring capabilities and ... - [Site sections](site-sections.md): {% hint style="info" %} - [Site settings](site-settings.md): {% hint style="info" %} - [Site share links](site-share-links.md): Manage the lifecycle of share links for your published sites. This includes generating new links for external sharing... - [Site spaces](site-spaces.md): Associate or dissociate your organization's spaces to keep your content organized. This is particularly useful for la... - [Site structure](site-structure.md): The content on your site comes from [spaces](https://gitbook.com/docs/creating-content/content-structure/space) in yo... - [Site users](site-users.md): Invite, remove, or update user permissions for a site. This provides a way to tightly control collaboration and visib... - [Space comments](space-comments.md): Comments are a powerful way to gather feedback on your documentation. Use this API to post, list, update, or delete c... - [Space content](space-content.md): Handle your space content programmatically by creating, updating, or listing pages and files. Ideal for bulk operatio... - [Space embeds](space-embeds.md): Automatically fetch metadata or previews for embedded resources such as videos, images, or external docs, enabling ri... - [Space integrations](space-integrations.md): This API handles the registration and removal of integrations, automating how data flows between GitBook and your cho... - [Space teams](space-teams.md): Assign entire teams to your spaces and streamline the process of granting or revoking access at scale, without dealin... - [Space users](space-users.md): Give your collaborators the right level of access for specific spaces. This endpoint makes it simple to add, remove, ... - [Spaces](space.md): A space is a project that lets you work on a collection of related pages. They allow you to write content, organize p... - [Spaces](spaces.md): Spaces are containers for your documentation or knowledge base content. Use this API to create new spaces, manage exi... - [Sponsored site plan](sponsored-site-plan.md): {% hint style="info" %} - [SSO & SAML](sso-and-saml.md): {% hint style="info" %} - [SSO Members vs non-SSO](sso-members-vs-non-sso.md): Users who have created a GitBook account with an email used in your SAML Identity Provider, or joined your organizati... - [SSO](sso.md): Tie GitBook into your corporate identity management and authentication providers (like SAML or OAuth). This centraliz... - [Privacy Statement](statement.md): Effective date: **May 25, 2018** - [Stepper](stepper.md): Stepper blocks let you break down a tutorial or guide into separate, but clearly linked steps. Each step can contain ... - [Storage](storage.md): Whether you're hosting images, documents, or other assets, Storage endpoints allow you to integrate those files into ... - [Structuring your API reference](structuring-your-api-reference.md): GitBook does more than just render your OpenAPI spec. It lets you customize your API reference for better clarity, na... - [Subdomains](subdomains.md): Provide a branded subdomain for each organization to create a consistent user experience. This API supports subdomain... - [Submit your integration for review](submit-your-app-for-review.md): After [bootstrapping](https://gitbook.com/docs/developers/integrations/quickstart) and [publishing](https://gitbook.c... - [Subprocessors](subprocessors.md): When we share your information with third party subprocessors, such as our vendors and service providers, we remain r... - [Suggestions automatiques de documentation](suggestions-automatiques-de-documentation.md): {% hint style="info" %} - [Integrating with CI/CD](support-for-ci-cd-with-api-blocks.md): GitBook can work with any CI/CD pipeline you already have for managing your OpenAPI specification. By using the GitBo... - [System info](system-info.md): Use these endpoints to monitor the overall health of GitBook's infrastructure or to retrieve version information for ... - [Tables](table.md): You can add tables to better organize your information in a GitBook page. - [Tabs](tabs.md): A tab block is a single block with the option to add multiple tabs. - [探索您的数据](tan-suo-nin-de-shu-ju.md): 一旦 GitBook Agent 开始摄取对话，它会将您的数据分类为三类： - [Task lists](task-list.md): Task lists allow you to create a list of items with checkboxes that you can check or uncheck. - [Team members](team-members.md): Easily add or remove users from teams, as well as fine-tune their specific roles within a team to ensure secure, well... - [Teams](teams.md): Teams allow you to manage user access at scale. By creating a specific team, consisting of multiple members, you can ... - [Terms of Service](terms.md): *Thank you for using GitBook! We're happy you're here. Please read this Terms of Service agreement carefully before a... - [Testing with segments](testing-with-segments.md): Segments allow you to test the conditions you set by defining claims on a mock user. - [Toolbar on published sites and site previews](toolbar-on-published-sites-and-site-previews.md): When viewing your live docs site, you may see a toolbar appear at the bottom of the browser window. It provides quick... - [共有とソーシャル](tossharu.md): カスタマイズメニューの **共有** タブから、サイトのメタデータおよびフッターにソーシャルアカウントを追加できます。 - [Track advanced analytics with GitBook's Events Aggregation API](track-advanced-analytics-with-gitbooks-events-aggregation-api.md): This guide will explain how to extract meaningful analytics data from your GitBook site, understand visitor behavior ... - [Track documentation analytics with Google Analytics](track-documentation-analytics-with-google-analytics.md): The Google Analytics integration for GitBook is available for all plans and provides an easy way to monitor your site... - [Private Spaces](trademark-policy-1.md): Some accounts, such as paid accounts, may have private spaces, which allow the User to control access to Content. - [Trademark Policy](trademark-policy.md): Using a company or business name, logo, or other trademark-protected materials in a manner that may mislead or confus... - [Translations](translations.md): {% hint style="warning" %} - [Troubleshooting](troubleshooting.md): When Git Sync is enabled, be careful not to create readme files through the GitBook UI. Creating readme files through... - [Unordered lists](unordered-list.md): Unordered lists are great for making a series of points that do not necessarily need to be made in a particular order... - [Updates](updates.md): An updates block lets you share new releases on your site in a format that matches established best practices for cha... - [Embed a playable video into your GitBook docs](upload-and-embed-a-playable-video-into-your-gitbook-docs.md): The best way to [embed videos](https://app.gitbook.com/s/NkEGS7hzeqa35sMXQZ4X/creating-content/blocks/embed-a-url) in... - [URL](url.md): {% hint style="info" %} - [URLs](urls.md): Manage official endpoints, direct deep links, or short links for your content. This allows you to keep track of multi... - [Use GitHub Actions to translate GitBook pages](use-github-actions-to-translate-gitbook-pages.md): {% hint style="warning" %} - [Users](users.md): The Users API allows you to fetch data about GitBook users, including the authenticated account or other team members... - [Authentication](using-with-authenticated-docs.md): If your GitBook documentation requires authentication (e.g., visitor authentication via OIDC, Auth0, or a custom back... - [Variables and expressions](variables-and-expressions.md): With variables you can create reusable text that can be conditionally referenced in [expressions](https://gitbook.com... - [Content variants](variants.md): You can publish multiple versions of the same documentation as part of a single docs site. These variants will be ava... - [Version control](version-control.md): You can easily monitor all the changes people have made to your content using to the **Version history** side panel. - [Receive webhook notifications](webhook.md): The [Webhook integration](https://www.gitbook.com/integrations/webhook) allows you to receive real-time notifications... - [What does GitBook’s trial include?](what-does-gitbooks-trial-include.md): The free trial allows you to test GitBook’s features, start onboarding your team, and create or import your content w... - [What does "Not set" means in referrer insights?](what-does-not-set-means-in-referrer-insights.md): When reviewing your GitBook analytics, "not set" referrers indicate **direct traffic**. This means visitors typed you... - [What does “Page not found” mean in insights?](what-does-page-not-found-mean-in-insights.md): “Page not found” in insights means users tried to visit a page in your documentation that doesn’t exist. The table on... - [What happens to my content if an account or organization is deleted?](what-happens-to-my-content-if-an-account-or-organization-is-deleted.md): If your content was deleted as a result of deleting an organization, all content associated with that organization is... - [What happens to my site when I delete a space connected to it?](what-happens-to-my-site-when-i-delete-a-space-connected-to-it.md): The deleted space will be removed from the site. - [What is a default space and how to change it?](what-is-a-default-space-and-how-to-change-it.md): When your **Docs site** has multiple spaces linked to it , it is referred to as a multi-variant site. This allows you... - [What is GitBook Agent?](what-is-gitbook-agent.md): GitBook Agent is an AI teammate that works alongside you, helping you keep your documentation accurate, complete, and... - [Which payment methods do you accept?](what-payment-methods-do-you-accept.md): We support the most common payment methods globally. You will be able to view the options supported in your region in... - [What’s the recommended page cover image size?](whats-the-recommended-page-cover-image-size.md): The ideal cover image size is 1990 × 480 pixels (px). Cover images will be locked to this aspect ratio, so these prop... - [Where can I find API ids?](where-can-i-find-api-ids.md): When interacting with the GitBook API, you'll frequently need to provide specific identifiers. The most common of the... - [Where can I find my invoices, and update billing details?](where-can-i-find-my-invoices-and-update-billing-details.md): GitBook uses Stripe for billing. To access your invoices: - [I can't find where to put my Google Analytics tracking ID](where-do-i-put-my-google-analytics-tracking-id.md): The Google Analytics integration for GitBook allows you to track traffic in your published sites from your Google Ana... - [Which authentication method should I use for Adaptive content?](which-authentication-method-should-i-use-for-adaptive-content.md): It depends on how you want to control access: - [Why am I getting a Git authentication failed message?](why-am-i-getting-a-git-authentication-failed-message.md): This message will appear if you are attempting to push to a public GitHub repository that hasn't granted GitBook access. - [Why am I seeing “We couldn’t load the integration” in GitBook?](why-am-i-seeing-we-couldnt-load-the-integration-in-gitbook.md): If you see this message, the most common cause is an ad blocker or privacy extension preventing the integration from ... - [Why I am not receiving emails from GitBook?](why-i-am-not-receiving-emails-from-gitbook.md): There can be several reasons why you may not be receiving emails from us, which include but are not limited to: - [Why I am not receiving notifications?](why-i-am-not-receiving-notifications.md): There can be several reasons why you may not be receiving notifications, which include but are not limited to: - [Why is my Site insights data not loading?](why-is-my-site-insights-data-not-loading.md): If your Site insights dashboard isn’t loading, it’s usually because an ad blocker or privacy extension is blocking th... - [Why is my space still indexed in search engines after I unpublished it?](why-is-my-space-still-indexed-in-search-engines-after-i-unpublished-it.md): Google's search engine takes time to update its index, which means that if you have unpublished or unindexed a space ... - [Why is the Mermaid block not loading?](why-is-the-mermaid-block-not-loading.md): Mermaid lets you create diagrams and visualizations using text and code. Learning Mermaid's syntax should not be a pr... - [Why my Adaptive Content segments aren't working or showing in preview?](why-my-adaptive-content-segments-arent-working-or-showing-in-preview.md): If your segments aren’t working properly, check the following: - [Writing with GitBook Agent](write-and-edit-with-ai.md): {% hint style="info" %} - [Editing](writing-and-editing.md): If the GitBook app is not loading or crashing on certain pages, it’s usually because an ad blocker or privacy extensi... - [与 GitBook Agent 一起审阅变更请求](yu-gitbook-agent-yi-qi-shen-yue-bian-geng-qing-qiu.md): 以及 [创建内容](https://gitbook.com/docs/documentation/zh/gitbook-agent/write-and-edit-with-ai)，GitBook Agent 可以审查您的变更请求以快速... - [自动文档建议](zi-dong-wen-dang-jian-yi.md): {% hint style="info" %}