# Table of Contents - [GitBook documentation | GitBook Documentation](#gitbook-documentation-gitbook-documentation) - [GitBook 文档 | GitBook Documentation](#gitbook-gitbook-documentation) - [GitHub 与 GitLab 同步 | GitBook Documentation](#github-gitlab-gitbook-documentation) - [导入内容 | GitBook Documentation](#-gitbook-documentation) - [快速入门 | GitBook Documentation](#-gitbook-documentation) - [启用 GitLab 同步 | GitBook Documentation](#-gitlab-gitbook-documentation) - [启用 GitHub 同步 | GitBook Documentation](#-github-gitbook-documentation) - [GitHub 拉取请求预览 | GitBook Documentation](#github-gitbook-documentation) - [单一仓库（Monorepos） | GitBook Documentation](#-monorepos-gitbook-documentation) - [提交消息与自动链接 | GitBook Documentation](#-gitbook-documentation) - [内容配置 | GitBook Documentation](#-gitbook-documentation) - [内容结构 | GitBook Documentation](#-gitbook-documentation) - [格式化您的内容 | GitBook Documentation](#-gitbook-documentation) - [段落 | GitBook Documentation](#-gitbook-documentation) - [任务列表 | GitBook Documentation](#-gitbook-documentation) - [空间 | GitBook Documentation](#-gitbook-documentation) - [集合 | GitBook Documentation](#-gitbook-documentation) - [有序列表 | GitBook Documentation](#-gitbook-documentation) - [Markdown | GitBook Documentation](#markdown-gitbook-documentation) - [无序列表 | GitBook Documentation](#-gitbook-documentation) - [区块 | GitBook Documentation](#-gitbook-documentation) - [标题 | GitBook Documentation](#-gitbook-documentation) - [引用 | GitBook Documentation](#-gitbook-documentation) - [故障排除 | GitBook Documentation](#-gitbook-documentation) - [提示 | GitBook Documentation](#-gitbook-documentation) - [分步器 | GitBook Documentation](#-gitbook-documentation) - [标签页 | GitBook Documentation](#-gitbook-documentation) - [嵌入的 URL | GitBook Documentation](#-url-gitbook-documentation) - [可展开 | GitBook Documentation](#-gitbook-documentation) - [绘图 | GitBook Documentation](#-gitbook-documentation) - [搜索内部内容 | GitBook Documentation](#-gitbook-documentation) - [文件 | GitBook Documentation](#-gitbook-documentation) - [页面 | GitBook Documentation](#-gitbook-documentation) - [数学与 TeX | GitBook Documentation](#-tex-gitbook-documentation) - [页面链接 | GitBook Documentation](#-gitbook-documentation) - [内联内容 | GitBook Documentation](#-gitbook-documentation) - [表格 | GitBook Documentation](#-gitbook-documentation) - [代码区块 | GitBook Documentation](#-gitbook-documentation) - [卡片 | GitBook Documentation](#-gitbook-documentation) - [变量与表达式 | GitBook Documentation](#-gitbook-documentation) - [列 | GitBook Documentation](#-gitbook-documentation) - [图片 | GitBook Documentation](#-gitbook-documentation) - [Unknown](#unknown) - [Unknown](#unknown) - [Editing & publishing documentation: In this section | Guides | GitBook Documentation](#editing-publishing-documentation-in-this-section-guides-gitbook-documentation) - [The complete guide to creating and publishing documentation in GitBook [updated for 2025] | Guides | GitBook Documentation](#the-complete-guide-to-creating-and-publishing-documentation-in-gitbook-updated-for-2025-guides-gitbook-documentation) - [Site Policy on GitBook | Policies | GitBook Documentation](#site-policy-on-gitbook-policies-gitbook-documentation) - [Help Center | GitBook Documentation](#help-center-gitbook-documentation) - [Private Spaces | Policies | GitBook Documentation](#private-spaces-policies-gitbook-documentation) - [DMCA Takedown Policy | Policies | GitBook Documentation](#dmca-takedown-policy-policies-gitbook-documentation) - [Help Center | GitBook Documentation](#help-center-gitbook-documentation) - [How can I export my content? | Help Center | GitBook Documentation](#how-can-i-export-my-content-help-center-gitbook-documentation) - [What does GitBook’s trial include? | Help Center | GitBook Documentation](#what-does-gitbook-s-trial-include-help-center-gitbook-documentation) - [Guide to Submitting a DMCA Takedown Notice | Policies | GitBook Documentation](#guide-to-submitting-a-dmca-takedown-notice-policies-gitbook-documentation) - [Reporting bugs and vulnerabilities | Policies | GitBook Documentation](#reporting-bugs-and-vulnerabilities-policies-gitbook-documentation) - [Guide to Submitting a DMCA Counter Notice | Policies | GitBook Documentation](#guide-to-submitting-a-dmca-counter-notice-policies-gitbook-documentation) - [How can I transfer billing and invoice management to another team member? | Help Center | GitBook Documentation](#how-can-i-transfer-billing-and-invoice-management-to-another-team-member-help-center-gitbook-documentation) - [If I subscribe to a paid plan, can I remove the "Powered by GitBook" badge? | Help Center | GitBook Documentation](#if-i-subscribe-to-a-paid-plan-can-i-remove-the-powered-by-gitbook-badge-help-center-gitbook-documentation) - [Inline content | GitBook Documentation](#inline-content-gitbook-documentation) - [Security FAQ | Policies | GitBook Documentation](#security-faq-policies-gitbook-documentation) - [Where can I find my invoices, and how do I update billing details? | Help Center | GitBook Documentation](#where-can-i-find-my-invoices-and-how-do-i-update-billing-details-help-center-gitbook-documentation) - [Can I edit GitBook on a smartphone? | Help Center | GitBook Documentation](#can-i-edit-gitbook-on-a-smartphone-help-center-gitbook-documentation) - [Is there a storage limit for asset uploads? | Help Center | GitBook Documentation](#is-there-a-storage-limit-for-asset-uploads-help-center-gitbook-documentation) - [I have paid for the yearly plan. Why did I receive another invoice? | Help Center | GitBook Documentation](#i-have-paid-for-the-yearly-plan-why-did-i-receive-another-invoice-help-center-gitbook-documentation) - [Managing API operations | GitBook Documentation](#managing-api-operations-gitbook-documentation) - [My custom subdomain isn't working. How do I troubleshoot DNS issues? | Help Center | GitBook Documentation](#my-custom-subdomain-isn-t-working-how-do-i-troubleshoot-dns-issues-help-center-gitbook-documentation) - [How can I make sure my company info is included on my receipts? | Help Center | GitBook Documentation](#how-can-i-make-sure-my-company-info-is-included-on-my-receipts-help-center-gitbook-documentation) - [Where can I find my receipts or invoices? | Help Center | GitBook Documentation](#where-can-i-find-my-receipts-or-invoices-help-center-gitbook-documentation) - [How do I change or update my custom domain in GitBook? | Help Center | GitBook Documentation](#how-do-i-change-or-update-my-custom-domain-in-gitbook-help-center-gitbook-documentation) - [Why I am not receiving notifications? | Help Center | GitBook Documentation](#why-i-am-not-receiving-notifications-help-center-gitbook-documentation) - [How can I publish a space? | Help Center | GitBook Documentation](#how-can-i-publish-a-space-help-center-gitbook-documentation) - [Is GitBook SOC 2 certified? | Help Center | GitBook Documentation](#is-gitbook-soc-2-certified-help-center-gitbook-documentation) - [Why am I seeing “We couldn’t load the integration” in GitBook? | Help Center | GitBook Documentation](#why-am-i-seeing-we-couldn-t-load-the-integration-in-gitbook-help-center-gitbook-documentation) - [Collections | GitBook Documentation](#collections-gitbook-documentation) - [How do I install the Intercom integration on my site? | Help Center | GitBook Documentation](#how-do-i-install-the-intercom-integration-on-my-site-help-center-gitbook-documentation) - [How can I publish a site with multiple versions? | Help Center | GitBook Documentation](#how-can-i-publish-a-site-with-multiple-versions-help-center-gitbook-documentation) - [What's the difference between a space and a docs site? | Help Center | GitBook Documentation](#what-s-the-difference-between-a-space-and-a-docs-site-help-center-gitbook-documentation) - [Toolbar on published sites and site previews | GitBook Documentation](#toolbar-on-published-sites-and-site-previews-gitbook-documentation) - [Setting up AWS Cognito | GitBook Documentation](#setting-up-aws-cognito-gitbook-documentation) - [How does GitBook handle SEO? | Help Center | GitBook Documentation](#how-does-gitbook-handle-seo-help-center-gitbook-documentation) - [Git Sync | Help Center | GitBook Documentation](#git-sync-help-center-gitbook-documentation) - [Is there a limit on the documentation import size or number? | Help Center | GitBook Documentation](#is-there-a-limit-on-the-documentation-import-size-or-number-help-center-gitbook-documentation) - [Does GitBook have a find and replace feature? | Help Center | GitBook Documentation](#does-gitbook-have-a-find-and-replace-feature-help-center-gitbook-documentation) - [FAQs | Help Center | GitBook Documentation](#faqs-help-center-gitbook-documentation) - [SSO Members vs non-SSO | GitBook Documentation](#sso-members-vs-non-sso-gitbook-documentation) - [Can I build my own integration? | Help Center | GitBook Documentation](#can-i-build-my-own-integration-help-center-gitbook-documentation) - [What happens to my content if an account or organization is deleted? | Help Center | GitBook Documentation](#what-happens-to-my-content-if-an-account-or-organization-is-deleted-help-center-gitbook-documentation) - [What is a default space and how to change it? | Help Center | GitBook Documentation](#what-is-a-default-space-and-how-to-change-it-help-center-gitbook-documentation) - [How can I access insights or analytics? | Help Center | GitBook Documentation](#how-can-i-access-insights-or-analytics-help-center-gitbook-documentation) - [Setting up OIDC | GitBook Documentation](#setting-up-oidc-gitbook-documentation) - [How do I change or replace the favicon for my docs site? | Help Center | GitBook Documentation](#how-do-i-change-or-replace-the-favicon-for-my-docs-site-help-center-gitbook-documentation) - [Setting up Okta | GitBook Documentation](#setting-up-okta-gitbook-documentation) - [Which authentication method should I use for Adaptive content? | Help Center | GitBook Documentation](#which-authentication-method-should-i-use-for-adaptive-content-help-center-gitbook-documentation) - [Reference | GitBook Documentation](#reference-gitbook-documentation) - [How do I transfer an organization to a different account? | Help Center | GitBook Documentation](#how-do-i-transfer-an-organization-to-a-different-account-help-center-gitbook-documentation) - [Can I embed an iframe in GitBook? | Help Center | GitBook Documentation](#can-i-embed-an-iframe-in-gitbook-help-center-gitbook-documentation) - [What does "Not set" means in referrer insights? | Help Center | GitBook Documentation](#what-does-not-set-means-in-referrer-insights-help-center-gitbook-documentation) - [Authenticated access | GitBook Documentation](#authenticated-access-gitbook-documentation) - [Security as a company value | Policies | GitBook Documentation](#security-as-a-company-value-policies-gitbook-documentation) - [Why has my account been disabled by administrator? | Help Center | GitBook Documentation](#why-has-my-account-been-disabled-by-administrator-help-center-gitbook-documentation) - [Why can't I see an option to approve a review request? | Help Center | GitBook Documentation](#why-can-t-i-see-an-option-to-approve-a-review-request-help-center-gitbook-documentation) - [AI Policy | Policies | GitBook Documentation](#ai-policy-policies-gitbook-documentation) - [Error: SignatureDoesNotMatch -SAML SSO | Help Center | GitBook Documentation](#error-signaturedoesnotmatch-saml-sso-help-center-gitbook-documentation) - [Can I have a partially public site with some authenticated content using Adaptive content? | Help Center | GitBook Documentation](#can-i-have-a-partially-public-site-with-some-authenticated-content-using-adaptive-content-help-center-gitbook-documentation) - [How can I solve the "path is already taken" error? | Help Center | GitBook Documentation](#how-can-i-solve-the-path-is-already-taken-error-help-center-gitbook-documentation) - [Why am I getting: Error: auth/invalid-email | Help Center | GitBook Documentation](#why-am-i-getting-error-auth-invalid-email-help-center-gitbook-documentation) - [What’s the recommended page cover image size? | Help Center | GitBook Documentation](#what-s-the-recommended-page-cover-image-size-help-center-gitbook-documentation) - [Why aren’t my Adaptive Content segments working or showing in preview? | Help Center | GitBook Documentation](#why-aren-t-my-adaptive-content-segments-working-or-showing-in-preview-help-center-gitbook-documentation) - [Can I request an integration? | Help Center | GitBook Documentation](#can-i-request-an-integration-help-center-gitbook-documentation) - [What does “Page not found” mean in insights? | Help Center | GitBook Documentation](#what-does-page-not-found-mean-in-insights-help-center-gitbook-documentation) - [Setting up a custom backend | GitBook Documentation](#setting-up-a-custom-backend-gitbook-documentation) - [Where do I put my Google Analytics tracking ID? | Help Center | GitBook Documentation](#where-do-i-put-my-google-analytics-tracking-id-help-center-gitbook-documentation) - [Can I move a space between organizations? | Help Center | GitBook Documentation](#can-i-move-a-space-between-organizations-help-center-gitbook-documentation) - [Where and how is my data stored? | Help Center | GitBook Documentation](#where-and-how-is-my-data-stored-help-center-gitbook-documentation) - [Why is the Mermaid block not loading? | Help Center | GitBook Documentation](#why-is-the-mermaid-block-not-loading-help-center-gitbook-documentation) - [Where can I install an integration? | Help Center | GitBook Documentation](#where-can-i-install-an-integration-help-center-gitbook-documentation) - [Error: auth/email-already-in-use | Help Center | GitBook Documentation](#error-auth-email-already-in-use-help-center-gitbook-documentation) - [Does GitBook support Google Tag Manager? | Help Center | GitBook Documentation](#does-gitbook-support-google-tag-manager-help-center-gitbook-documentation) - [Can I receive my receipts via email? | Help Center | GitBook Documentation](#can-i-receive-my-receipts-via-email-help-center-gitbook-documentation) - [How to preview a docs site? | Help Center | GitBook Documentation](#how-to-preview-a-docs-site-help-center-gitbook-documentation) - [Can I move a page between spaces? | Help Center | GitBook Documentation](#can-i-move-a-page-between-spaces-help-center-gitbook-documentation) - [What happens to my site when I delete a space connected to it? | Help Center | GitBook Documentation](#what-happens-to-my-site-when-i-delete-a-space-connected-to-it-help-center-gitbook-documentation) - [How do I install an integration on my site? | Help Center | GitBook Documentation](#how-do-i-install-an-integration-on-my-site-help-center-gitbook-documentation) - [Why I am not receiving emails from GitBook? | Help Center | GitBook Documentation](#why-i-am-not-receiving-emails-from-gitbook-help-center-gitbook-documentation) - [Why is my image not loading? | Help Center | GitBook Documentation](#why-is-my-image-not-loading-help-center-gitbook-documentation) - [Does GitBook have a CLI tool? | Help Center | GitBook Documentation](#does-gitbook-have-a-cli-tool-help-center-gitbook-documentation) - [Does GitBook support RTL? | Help Center | GitBook Documentation](#does-gitbook-support-rtl-help-center-gitbook-documentation) - [How do I set up Adaptive content with my custom OIDC provider? | Help Center | GitBook Documentation](#how-do-i-set-up-adaptive-content-with-my-custom-oidc-provider-help-center-gitbook-documentation) - [Which blocks can be added inside an expandable block? | Help Center | GitBook Documentation](#which-blocks-can-be-added-inside-an-expandable-block-help-center-gitbook-documentation) - [Billing policy | GitBook Documentation](#billing-policy-gitbook-documentation) - [How can I remove organization members? | Help Center | GitBook Documentation](#how-can-i-remove-organization-members-help-center-gitbook-documentation) - [When I invite a new member to my GitBook organization, when will I be charged? | Help Center | GitBook Documentation](#when-i-invite-a-new-member-to-my-gitbook-organization-when-will-i-be-charged-help-center-gitbook-documentation) - [How can I change the slug in the URL? | Help Center | GitBook Documentation](#how-can-i-change-the-slug-in-the-url-help-center-gitbook-documentation) - [Do you offer any discounts? | Help Center | GitBook Documentation](#do-you-offer-any-discounts-help-center-gitbook-documentation) - [Can I edit HTML, CSS, JS, or other custom code on GitBook? | Help Center | GitBook Documentation](#can-i-edit-html-css-js-or-other-custom-code-on-gitbook-help-center-gitbook-documentation) - [Do I have to pay to publish a site? | Help Center | GitBook Documentation](#do-i-have-to-pay-to-publish-a-site-help-center-gitbook-documentation) - [Are guests or readers free members? | Help Center | GitBook Documentation](#are-guests-or-readers-free-members-help-center-gitbook-documentation) - [Teams | GitBook Documentation](#teams-gitbook-documentation) - [How can I apply for a Community plan? | Help Center | GitBook Documentation](#how-can-i-apply-for-a-community-plan-help-center-gitbook-documentation) - [How to unpublish a site? | Help Center | GitBook Documentation](#how-to-unpublish-a-site-help-center-gitbook-documentation) - [Why is my space still indexed in search engines after I unpublished it? | Help Center | GitBook Documentation](#why-is-my-space-still-indexed-in-search-engines-after-i-unpublished-it-help-center-gitbook-documentation) - [Does Gitbook Support MP4 files? | Help Center | GitBook Documentation](#does-gitbook-support-mp4-files-help-center-gitbook-documentation) - [Why is my Site insights data not loading? | Help Center | GitBook Documentation](#why-is-my-site-insights-data-not-loading-help-center-gitbook-documentation) - [How do I transfer the ownership of an organization to another email/person? | Help Center | GitBook Documentation](#how-do-i-transfer-the-ownership-of-an-organization-to-another-email-person-help-center-gitbook-documentation) - [Does GitBook offer a free plan for non-profit/open-source organizations? | Help Center | GitBook Documentation](#does-gitbook-offer-a-free-plan-for-non-profit-open-source-organizations-help-center-gitbook-documentation) - [Permissions and inheritance | GitBook Documentation](#permissions-and-inheritance-gitbook-documentation) - [Describing enums | GitBook Documentation](#describing-enums-gitbook-documentation) - [Configuring the “Test it” button | GitBook Documentation](#configuring-the-test-it-button-gitbook-documentation) - [Setting up Azure AD | GitBook Documentation](#setting-up-azure-ad-gitbook-documentation) - [Can I change my billing method to invoicing? | Help Center | GitBook Documentation](#can-i-change-my-billing-method-to-invoicing-help-center-gitbook-documentation) - [Community plan | GitBook Documentation](#community-plan-gitbook-documentation) - [What payment methods do you accept? | Help Center | GitBook Documentation](#what-payment-methods-do-you-accept-help-center-gitbook-documentation) - [When will I be charged for inviting a new member to my organization? | Help Center | GitBook Documentation](#when-will-i-be-charged-for-inviting-a-new-member-to-my-organization-help-center-gitbook-documentation) - [How can I add a custom domain to a docs site? | Help Center | GitBook Documentation](#how-can-i-add-a-custom-domain-to-a-docs-site-help-center-gitbook-documentation) - [Why Was I Charged for an Unexpected Plan Upgrade? | Help Center | GitBook Documentation](#why-was-i-charged-for-an-unexpected-plan-upgrade-help-center-gitbook-documentation) - [Can I get a refund? | Help Center | GitBook Documentation](#can-i-get-a-refund-help-center-gitbook-documentation) - [Feature flags | GitBook Documentation](#feature-flags-gitbook-documentation) - [URL | GitBook Documentation](#url-gitbook-documentation) - [Enabling authenticated access | GitBook Documentation](#enabling-authenticated-access-gitbook-documentation) - [Configuring a subdirectory with Vercel | GitBook Documentation](#configuring-a-subdirectory-with-vercel-gitbook-documentation) - [Integrating with CI/CD | GitBook Documentation](#integrating-with-ci-cd-gitbook-documentation) - [Creating custom tools | GitBook Documentation](#creating-custom-tools-gitbook-documentation) - [Configuring a subdirectory with Cloudflare | GitBook Documentation](#configuring-a-subdirectory-with-cloudflare-gitbook-documentation) - [Adding custom code samples | GitBook Documentation](#adding-custom-code-samples-gitbook-documentation) - [Invite or remove members | GitBook Documentation](#invite-or-remove-members-gitbook-documentation) - [Search & Quick find | GitBook Documentation](#search-quick-find-gitbook-documentation) - [Structuring your API reference | GitBook Documentation](#structuring-your-api-reference-gitbook-documentation) - [Customizing the Assistant | GitBook Documentation](#customizing-the-assistant-gitbook-documentation) - [Setting up Auth0 | GitBook Documentation](#setting-up-auth0-gitbook-documentation) - [Configuring a subdirectory with AWS using CloudFront and Route 53 | GitBook Documentation](#configuring-a-subdirectory-with-aws-using-cloudfront-and-route-53-gitbook-documentation) - [Cookies | GitBook Documentation](#cookies-gitbook-documentation) - [Error: auth/expired-action-code | Help Center | GitBook Documentation](#error-auth-expired-action-code-help-center-gitbook-documentation) - [Unknown](#unknown) - [Sponsored site plan | GitBook Documentation](#sponsored-site-plan-gitbook-documentation) --- # GitBook documentation | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send [](https://gitbook.com/docs/getting-started/quickstart) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FNvO7UtbHpAKybB46Gm14%252Fenterprise.svg%3Falt%3Dmedia%26token%3D6ac9d95c-4617-49cf-8667-1de65e595de4&width=752&dpr=4&quality=100&sign=841b6977&sv=2) #### [](https://gitbook.com/docs/#quick-start) Quick start Get up and running fast with GitBook [](https://gitbook.com/docs/getting-started/git-sync) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F5eZLWp7DtVCKkh9tnFOQ%252FGit%2520Sync%2520%281%29.svg%3Falt%3Dmedia%26token%3Db77c4e1b-228c-4db2-a7eb-850f327285a0&width=752&dpr=4&quality=100&sign=d7417cd3&sv=2) #### [](https://gitbook.com/docs/#git-sync) Git Sync Sync with a Git repository to enable docs-as-code workflows [](https://gitbook.com/docs/creating-content/formatting) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FIa1CNbX9YMMv5RO446MO%252FContent%2520editor.svg%3Falt%3Dmedia%26token%3D1fc0e0dc-b003-4c6e-ba92-d3c4d1d18f1d&width=752&dpr=4&quality=100&sign=2e8693a9&sv=2) #### [](https://gitbook.com/docs/#create-content) Create content Create and format your docs using our block-based editor [](https://gitbook.com/docs/publishing-documentation/publish-a-docs-site) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FXhKtEQu1cgoQpV86CtDp%252FPublished%2520documentation.svg%3Falt%3Dmedia%26token%3Da5680a14-fc52-41f4-95c9-03e9ecdc54bb&width=752&dpr=4&quality=100&sign=766cd567&sv=2) #### [](https://gitbook.com/docs/#publish-your-docs) Publish your docs Publish your docs site to share with others **Essentials** * [Concepts](https://gitbook.com/docs/getting-started/concepts) * [Blocks](https://gitbook.com/docs/creating-content/blocks) * [Customization](https://gitbook.com/docs/publishing-documentation/customization) * [Authenticated access](https://gitbook.com/docs/publishing-documentation/authenticated-access) * [Custom domains](https://gitbook.com/docs/publishing-documentation/custom-domain) **AI-native docs** * [GitBook Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) * [MCP](https://gitbook.com/docs/publishing-documentation/mcp-servers-for-published-docs) * [AI Search](https://gitbook.com/docs/publishing-documentation/ai-search) * [Write & edit with AI](https://gitbook.com/docs/creating-content/write-and-edit-with-ai) * [LLM-ready docs](https://gitbook.com/docs/publishing-documentation/llm-ready-docs) **Popular topics** * [Adaptive content](https://gitbook.com/docs/publishing-documentation/adaptive-content) * [GitHub & GitLab Sync](https://gitbook.com/docs/getting-started/git-sync) * [Migrate to GitBook](https://gitbook.com/docs/getting-started/import) * [Content structure](https://gitbook.com/docs/creating-content/content-structure) * [Translations](https://gitbook.com/docs/creating-content/translations) Last updated 23 days ago Was this helpful? --- # GitBook 文档 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 在 GitBook，我们的使命是提供一个 **用户友好的** 和 **协作的** 用于创建、编辑和共享产品与 API 文档的解决方案。 [注册](https://app.gitbook.com/join?utm_content=homepage_button_sign_up&utm_source=gitbook_docs) [快速入门](https://gitbook.com/docs/documentation/zh/ru-men/quickstart) ### [](https://gitbook.com/docs/documentation/zh#fa-xian-gitbook) 发现 GitBook [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FIa1CNbX9YMMv5RO446MO%252FContent%2520editor.svg%3Falt%3Dmedia%26token%3D1fc0e0dc-b003-4c6e-ba92-d3c4d1d18f1d&width=490&dpr=4&quality=100&sign=30aa1267&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fwu8rTzPUvjdMmKYXDCqH%252FContent%2520editor.svg%3Falt%3Dmedia%26token%3Dd77fdae9-5d98-4f32-af67-08debcaefa36&width=490&dpr=4&quality=100&sign=f9c75ace&sv=2) **创建内容** 在 GitBook 中编辑页面、内容及更多内容。 [](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/publish-a-docs-site) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FXhKtEQu1cgoQpV86CtDp%252FPublished%2520documentation.svg%3Falt%3Dmedia%26token%3Da5680a14-fc52-41f4-95c9-03e9ecdc54bb&width=490&dpr=4&quality=100&sign=472168a5&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FW0cNoKHfhTPa0cxG695s%252FPublished%2520documentation.svg%3Falt%3Dmedia%26token%3Dda7482f9-ca21-4159-b34b-20ecec741611&width=490&dpr=4&quality=100&sign=584c36fb&sv=2) **发布文档** 发布你的文档站点以与他人分享。 [](https://gitbook.com/docs/documentation/zh/xie-zuo/live-edits) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FOjsCMlHhcq7wtscrZNH9%252FCollaboration.svg%3Falt%3Dmedia%26token%3Dbbd503d9-6b22-46f2-9247-c1f4e59fcb70&width=490&dpr=4&quality=100&sign=c98a3cbe&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fu5bFdyogbB9CHgW48cKE%252FCollaboration.svg%3Falt%3Dmedia%26token%3D068f449a-5876-4571-8206-dc1f8b4e4dac&width=490&dpr=4&quality=100&sign=aaeea991&sv=2) **协作** 邀请你的团队并在 GitBook 中协作。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F5eZLWp7DtVCKkh9tnFOQ%252FGit%2520Sync%2520%281%29.svg%3Falt%3Dmedia%26token%3Db77c4e1b-228c-4db2-a7eb-850f327285a0&width=490&dpr=4&quality=100&sign=b2490181&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FZBqE2J4z6MGeOy65AMZJ%252FGit%2520Sync.svg%3Falt%3Dmedia%26token%3Def0c64ff-6331-4726-a8b7-6bd4d56c7c8c&width=490&dpr=4&quality=100&sign=a9fb27b&sv=2) **Git 同步** 与 Git 仓库同步以启用高级工作流。 [](https://gitbook.com/docs/documentation/zh/ji-cheng/install-an-integration) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FzvuPBpE9H98mgDoBbYdy%252FIntegrations.svg%3Falt%3Dmedia%26token%3Dab5c2d76-8103-4fe8-becb-cd7cd2174925&width=490&dpr=4&quality=100&sign=7cd8403a&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FZphNuTHaW8sMq3zOuYyE%252FIntegrations.svg%3Falt%3Dmedia%26token%3D5a8663d9-0dc6-4164-9d4b-9fe272ed1ccc&width=490&dpr=4&quality=100&sign=2e2c20f8&sv=2) **集成** 与您喜欢的工具和应用集成。 [](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/plans) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FjBQQrTMqLg2PcsFruhz8%252FAccount%2520management.svg%3Falt%3Dmedia%26token%3D7f1a8521-4aee-493b-8d33-4c25c2a599d5&width=490&dpr=4&quality=100&sign=25ba6d17&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F2t8RlgynmXSTQySTVEn3%252FAccount%2520management.svg%3Falt%3Dmedia%26token%3Db429a514-ca1d-4dfa-88cf-b484ca5080d8&width=490&dpr=4&quality=100&sign=19dae8f6&sv=2) **账户管理** 管理你的组织、账户和账单。 最后更新于1个月前 这有帮助吗？ --- # GitHub 与 GitLab 同步 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ![A GitBook screenshot showing the Git Sync setup](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FwGBRqcgxpK562ZksP7oy%252F10_01_25_git_sync.svg%3Falt%3Dmedia%26token%3Dda06acc3-15f8-4fde-ab65-c3c38ef4f31c&width=768&dpr=4&quality=100&sign=a7a39fc8&sv=2) 为您的 GitBook 空间设置 Git 同步。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync#gai-shu) 概述 Git 同步允许技术团队将 GitHub 或 GitLab 仓库与 GitBook 同步，并将 Markdown 文件转换为美观且易于使用的文档。可以直接在 GitBook 强大的编辑器中编辑，同时保持与 GitHub 或 GitLab 代码库的内容同步。 Git 同步是双向的，因此您在 GitBook 编辑器中直接进行的更改会自动同步，GitHub 或 GitLab 上的任何提交也会同步。这允许开发人员直接从 GitHub 或 GitLab 提交代码，而技术写手、教学设计师和产品经理则可以直接在 GitBook 中编辑、讨论并反馈更改。 \-H 'Authorization: Bearer YOUR\_API\_KEY' \\ [管理员和创建者](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/member-management/roles) 可以启用并配置 Git 同步。 最后更新于5个月前 这有帮助吗？ --- # 导入内容 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以使用导入工具将现有文档迁移并统一到 GitBook 中。 您可以选择使用我们内置的导入工具导入单个或多个页面 —— 或者 [使用 Git 同步导入整个 Git 仓库](https://gitbook.com/docs/documentation/zh/ru-men/import#import-using-git-sync) . [](https://gitbook.com/docs/documentation/zh/ru-men/import#shi-yong-dao-ru-mian-ban) 使用导入面板 ------------------------------------------------------------------------------------------------ 导入面板可以轻松地将您的内容从其他文档网站或现有文件迁移到您的 GitBook 组织中。 当您选择从其他在线文档站点导入时，只需添加该站点的 URL，GitBook 会处理其余部分。 默认情况下，GitBook 使用 AI 来简化导入过程。它会智能地完善和清理不完全符合 GitBook 格式的导入内容 —— 这意味着输出将更加精炼并更有效地使用 GitBook 的区块。您可以在菜单中禁用此功能。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/import#zhi-chi-de-dao-ru-ge-shi) 支持的导入格式 GitBook 支持从以下格式的文档网站或文件导入： * Markdown (`.md` 或 `.markdown`) * HTML (`.html`) * Microsoft Word (`.docx`) GitBook 还支持从以下来源导入： * Confluence * Notion * GitHub Wiki * Quip * Dropbox Paper * Google Docs 如果您想要 **导入多个页面**，您可以上传包含 HTML 或 Markdown 文件的 ZIP 文件，或使用 **在线文档** 导入选项。 GitBook 基于 Markdown，因此以 Markdown 格式导入内容将获得最佳效果。如果您当前的工具支持导出为 Markdown，我们建议使用该格式以获得更顺畅的导入过程。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/import#dao-ru-mian-ban) 导入面板 ![A GitBook screenshot showing the import panel](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FQPGDN9Aja68uaLDdZt9M%252Fgetting-started-import-panel.svg%3Falt%3Dmedia%26token%3Dbf7114a5-c02c-4dfd-acc5-cf527d68309d&width=768&dpr=4&quality=100&sign=11904d14&sv=2) GitBook 中的导入面板。 当您创建新空间时，会在出现的模态窗口中提供导入内容的选项。如果您创建了一个空空间，也可以使用 **快速入门** 在您点击时新空页面底部的部分 **编辑**. 或者，您也可以通过选择随时导入页面或子页面 **添加新项** > **导入页面** 在 [目录](https://gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#table-of-contents) 底部，或通过打开 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 页面的 **并选择**. 导入子页面 选择输入来源后，您可以选择要导入的文件。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/import#gitbook-hui-cong-ge-zhong-lai-yuan-dao-ru-nei-rong-dan-chan-pin-gong-neng-he-wen-dang-ge-shi-de-cha) GitBook 会从各种来源导入内容，但产品功能和文档格式的差异可能导致导入内容与原始来源有所不同。 限制 * GitBook 当前对导入内容有以下限制： **20**. * 单次导入中可上传的最大页面数量为 **20**. * * * [](https://gitbook.com/docs/documentation/zh/ru-men/import#import-using-git-sync) 单次导入中可上传的最大文件数量（图像等）为 ------------------------------------------------------------------------------------------------------------ 使用 Git 同步从 GitHub 或 GitLab 仓库导入 [Git 同步](https://gitbook.com/docs/documentation/zh/ru-men/git-sync) 在将大量内容导入 GitBook 时，我们建议使用 虽然我们内置的迁移工具可以处理大多数导入，但 Git 同步更适合高效处理更大规模的迁移。 [您可以在下面找到导入内容的基本步骤。有关更详细的步骤和视频演示，请查看我们针对](https://gitbook.com/docs/guides/editing-and-publishing-documentation/import-or-migrate-your-content-to-gitbook-with-git-sync) . 1 #### [](https://gitbook.com/docs/documentation/zh/ru-men/import#shi-yong-git-tong-bu-jiang-nei-rong-dao-ru-gitbook) 使用 Git 同步将内容导入 GitBook GitBook 基于 Markdown，因此以 Markdown 格式导入内容将获得最佳效果。如果您当前的工具支持导出为 Markdown，我们建议使用该格式以获得更顺畅的导入过程。 将您的内容转换为 Markdown [如果您的内容尚未以 Markdown 文件存在，我们建议使用脚本（例如](https://github.com/microsoft/markitdown) Markitdown 2 #### [](https://gitbook.com/docs/documentation/zh/ru-men/import#huo-zai-xian-gong-ju-jiang-nin-de-nei-rong-zhuan-huan-wei-markdown) ）或在线工具将您的内容转换为 Markdown。 在 GitHub 或 GitLab 中组织您的内容 3 #### [](https://gitbook.com/docs/documentation/zh/ru-men/import#zai-she-zhi-nin-de-gitbook-zhan-dian-shi-wu-bi-zai-github-huo-gitlab-cang-ku-zhong-you-xiao-di-zu-zh) 在设置您的 GitBook 站点时，务必在 GitHub 或 GitLab 仓库中有效地组织您的内容。由于 Git 同步是在空间级别进行的，请仔细规划如何分组内容。创建多个仓库或文件夹，确保必要的 Markdown 文件位于正确的位置。 设置空间并配置 Git 同步 [为组织您的内容，根据需要在 GitBook 中创建一个或多个空间。安装](https://www.gitbook.com/integrations/github-sync) 或 [GitHub 同步](https://www.gitbook.com/integrations/gitlab-sync) GitLab 同步 4 #### [](https://gitbook.com/docs/documentation/zh/ru-men/import#zai-nin-de-zu-zhi-zhong-ji-cheng-bing-wei-zhe-xie-kong-jian-pei-zhi-ta-nin-xu-yao-jiang-nin-de-kong) 在您的组织中集成并为这些空间配置它。您需要将您的空间与前一步中设置的文件夹或仓库同步。 以 GitHub → GitBook 的方向运行 Git 同步 最后更新于5个月前 这有帮助吗？ --- # 快速入门 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ### [](https://gitbook.com/docs/documentation/zh/ru-men/quickstart#ru-men) 入门 您需要一个 GitBook 帐户才能开始发布文档。 [注册](https://app.gitbook.com/join?utm_content=quickstart_button_sign_up&utm_source=gitbook_docs) ### [](https://gitbook.com/docs/documentation/zh/ru-men/quickstart#chuang-jian-wen-dang-zhan-dian) 创建文档站点 当您首次注册时，您将有机会通过文档站点向导创建一个文档站点。您可以随时通过单击 **+** 侧栏中 **文档站点** 标题旁边的按钮再次启动该向导以创建新站点。 ![A GitBook screenshot showing the publishing step of the docs site wizard](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Ftr45YCskBmSWji7m4HZj%252Fgetting-started-quickstart.svg%3Falt%3Dmedia%26token%3D160e7114-067b-46cb-979d-5b6ce7b5d0c9&width=768&dpr=4&quality=100&sign=faafa924&sv=2) 使用文档站点向导，几分钟内即可发布您的第一个站点。 文档站点向导将引导您完成创建第一个站点的流程。您需要为站点命名，选择是从空白站点开始还是添加我们的示例内容，以及是否立即发布文档。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/quickstart#bian-ji-nin-de-nei-rong) 编辑您的内容 既然您已经创建了站点，就可以编辑或导入内容。如果您在 GitHub 或 GitLab 上已有包含文档的现有仓库，可以使用 [Git 同步](https://gitbook.com/docs/documentation/zh/ru-men/git-sync) 将内容轻松迁移并与 GitBook 同步。详细信息请参见 [使用 Git 同步迁移内容的指南](https://gitbook.com/docs/guides/editing-and-publishing-documentation/import-or-migrate-your-content-to-gitbook-with-git-sync) . 导入内容后，您可以使用 GitBook 的内置编辑器编辑页面并执行例如 [添加交互块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks) 、自定义 [页面布局](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page) 等操作。 如果您想了解有关 GitBook 编辑体验的更多信息，请查看以下资源： [](https://gitbook.com/docs/documentation/zh/xie-zuo/change-requests) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FFe03rMgRn98lDrMoqRdh%252FChange%2520Request.svg%3Falt%3Dmedia%26token%3Dea09f115-822e-4a9f-9ca2-b3a5a6497e5f&width=490&dpr=4&quality=100&sign=b9f3727c&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FTUKSbNWQs1VPoO5yuRxV%252FMake%2520your%2520documentation%2520process%2520more%2520collaborative%2520with%2520change%2520requests%2520%281%29.svg%3Falt%3Dmedia%26token%3Dffd9f2fc-c9b6-4e22-a1c3-605264ff8517&width=490&dpr=4&quality=100&sign=9e2b557a&sv=2) **发起变更请求** 与您的团队协作编写内容。 [](https://gitbook.com/docs/documentation/zh/ji-cheng/install-an-integration) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FzvuPBpE9H98mgDoBbYdy%252FIntegrations.svg%3Falt%3Dmedia%26token%3Dab5c2d76-8103-4fe8-becb-cd7cd2174925&width=490&dpr=4&quality=100&sign=7cd8403a&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F2AusRyLQRpZeNphjEgW7%252FIntegrations.svg%3Falt%3Dmedia%26token%3D3751e7db-c348-4d73-b1ca-960f1e029c69&width=490&dpr=4&quality=100&sign=e02f1f80&sv=2) **安装集成** 将您喜欢的工具与已发布的站点集成。 [](https://gitbook.com/docs/documentation/zh/api-can-kao/openapi) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fz8bfsj6BwyLBl2lX3VCJ%252FOpenAPI.svg%3Falt%3Dmedia%26token%3D63e297ee-7f94-4474-86cd-3e121d424634&width=490&dpr=4&quality=100&sign=40b6375e&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F8u6iW0gEgoeA0Aic0zmQ%252FOpenAPI.svg%3Falt%3Dmedia%26token%3Db3353633-6926-4eda-9554-c1e569e1052c&width=490&dpr=4&quality=100&sign=f0347185&sv=2) **添加 OpenAPI 规范** 将 API 方法直接添加到您的文档中。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/quickstart#zi-ding-yi-nin-de-zhan-dian) 自定义您的站点 您不仅可以编辑站点内容，还可以在站点发布后自定义与站点外观和感受相关的许多设置。 您可以更改诸如 [徽标、颜色和字体](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/customization) 、通过添加更多结构来设置 [站点部分](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-structure/site-sections) 和 [变体](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-structure/variants) ，或更新您的 [站点可见性](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-settings#audience) 设置。 您可以在以下资源中阅读有关自定义文档的更多信息： [](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/customization) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fg9kUW4Q6vBnDs0xP6z7b%252FCustomize.svg%3Falt%3Dmedia%26token%3D8467216f-6b71-4881-85ad-02c0c55e9ece&width=490&dpr=4&quality=100&sign=47f2ccdf&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FTKcZymjhCYVHntFXEm3u%252FCustomize.svg%3Falt%3Dmedia%26token%3D90013ca9-aa25-4144-be93-5704809f3136&width=490&dpr=4&quality=100&sign=99fbcc28&sv=2) **自定义您的站点** 自定义站点的外观和风格。 [](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/custom-domain) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FdCdWW6ZEVYv0M1tJ1WHL%252FDomain.svg%3Falt%3Dmedia%26token%3D41896c61-835c-41da-83e0-11ec10a109c4&width=490&dpr=4&quality=100&sign=13319b7d&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F5VdQ52ZSRUT3VJHQHBWR%252FDomain.svg%3Falt%3Dmedia%26token%3D48b5bd12-b80e-4d9b-b971-e9d275a441f4&width=490&dpr=4&quality=100&sign=b29a299&sv=2) **添加自定义域名** 为您的站点设置自定义域名。 [](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-settings) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fgit-blob-676622619daf1f4c5a2e8b618df1da57eb579797%252FSettings-card.svg%3Falt%3Dmedia&width=490&dpr=4&quality=100&sign=90338f70&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FtKaejufwVjhXW0DmoBrs%252FSettings.svg%3Falt%3Dmedia%26token%3D90e17ec7-499d-41cf-b9f0-da689b70f410&width=490&dpr=4&quality=100&sign=5098c674&sv=2) **更新站点设置** 更新与已发布站点相关的设置。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/quickstart#fa-bu-nin-de-wen-dang) 发布您的文档 最后，您已准备好将站点发布到公众。如果您还没有在向导中发布站点，可以随时从站点仪表板发布站点。 发布站点后，您将获得一个可以与任何人共享的链接！ 如果您遇到问题或有任何疑问，我们随时愿意提供帮助。 [加入我们的社区](https://github.com/orgs/GitbookIO/discussions) 或 [给我们的支持团队发送消息](https://gitbook.com/docs/help-center/further-help/how-do-i-contact-support) ，我们会从那里为您提供帮助。 想更深入了解发布流程？查看 [我们关于在 GitBook 中创建和发布内容的完整指南](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook) . 最后更新于2个月前 这有帮助吗？ --- # 启用 GitLab 同步 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-gitlab-sync#kuai-su-kai-shi) 快速开始 在您希望与 GitLab 仓库同步的空间中，前往右上角的空间菜单，然后选择 **与 Git 同步**从提供者列表中，选择 **GitLab Sync**，并点击 **配置**. ![A GitBook screenshot showing GitLab Sync configuration options](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FYmaLCLRBnzEYREzUVmLR%252F10_01_25_git_sync-gitlab.svg%3Falt%3Dmedia%26token%3D8ded6039-4bc7-4601-8841-b6b1afe083c8&width=768&dpr=4&quality=100&sign=5646c22f&sv=2) GitLab 同步配置选项。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-gitlab-sync#sheng-cheng-bing-shu-ru-nin-de-api-fang-wen-ling-pai) 生成并输入您的 API 访问令牌 您可以在 GitLab 的用户设置中生成 API 访问令牌。 在 GitLab 中有两种类型的访问令牌：项目令牌和个人令牌。请注意，为了使集成工作，您需要使用个人令牌，可从 GitLab 的用户偏好菜单生成。 确保为您的令牌启用以下访问权限： * `api` * `read_repository` * `write_repository` 如果您创建的令牌还附带了特定角色，也请确保它具有 `维护者` 或 `管理员` 角色。 然后在配置 GitLab 集成时，您可以将该令牌粘贴到 API 访问令牌字段中。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-gitlab-sync#xuan-ze-cang-ku-he-fen-zhi) 选择仓库和分支 选择您想与 GitBook 内容保持同步的仓库。 **看不到您的仓库？** 在创建 API 令牌时，确保已设置正确的权限。 选择正确的仓库后，选择要将提交推送到并从中同步的分支。 对于许多 GitLab 仓库， `main（主分支）` 分支可能会被自动设置为受保护。如果是这种情况，我们建议添加一个特定分支来同步您的内容。然后您可以将其合并到 `main（主分支）` 并保持保护设置不变。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-gitlab-sync#zhi-xing-chu-shi-tong-bu) 执行初始同步 首次同步时，您可以选择以下两种方向之一进行同步： 1. Git**Book** -> Git**Lab** 将同步您空间的内容 **到** 所选分支。如果您从一个空仓库开始并希望快速将 GitBook 内容导入，这是很好的选择。 2. Git**Lab** -> Git**Book** 将同步您空间的内容 **从** 所选分支。如果您的仓库中已有现有的 Markdown 内容并希望将其导入到 GitBook，这非常有用。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-gitlab-sync#bian-xie-bing-ti-jiao) 编写并提交 您可以开始了。您会注意到如果您的空间处于 [实时编辑](https://gitbook.com/docs/documentation/zh/xie-zuo/live-edits) 模式下，实时编辑现在被锁定。这允许 GitBook 在团队成员合并一个 [变更请求](https://gitbook.com/docs/documentation/zh/xie-zuo/change-requests) 到 GitBook 时可靠地将内容同步到您的仓库。 当您在 GitBook 上编辑时，每次更改请求的合并都会导致对您所选的 GitLab 分支进行一次提交。 当您向 GitLab 提交时，每次提交都会作为历史提交同步到您的 GitBook 空间。 最后更新于5个月前 这有帮助吗？ --- # 启用 GitHub 同步 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-github-sync#kuai-su-kai-shi) 快速开始 在您希望与 GitHub 仓库同步的空间中，前往 [空间标题](https://gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#space-header) 右上角的，选择 **配置**从提供者列表中，选择 **GitHub 同步**. ![A GitBook screenshot showing GitHub Sync configuration options](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FIBDpcktPGlj4eeYb2M5R%252Fgitsync-github.svg%3Falt%3Dmedia%26token%3D2f8c51a1-6153-4743-99a8-4bab9d4a99a0&width=768&dpr=4&quality=100&sign=843fde4d&sv=2) GitHub 同步 配置选项。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-github-sync#shi-yong-github-jin-xing-yan-zheng) 使用 GitHub 进行验证 如果您是第一次设置 GitHub 同步且尚未关联 GitHub 帐户，开始配置 Git 同步时系统会提示您进行关联。如果您已关联帐户，可能仍需要通过 GitHub 进行身份验证。 如果您看到一个 **'可能重复的帐户'** 在此步骤出现错误消息，这意味着您的 GitHub 帐户已与另一个 GitBook 用户帐户关联。 为帮助您识别已关联的帐户，您需要从此会话登出并使用“通过 GitHub 登录”的方法重新登录。 如果您已经知道与 GitHub 关联的 GitBook 帐户，您可以登录该用户帐户并在设置中取消关联您的 GitHub 帐户，然后再重新登录并将当前帐户关联。 在我们的 [故障排除 页面 阅读更多](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#potential-duplicated-accounts-when-signing-in) . ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-github-sync#jiang-gitbook-ying-yong-an-zhuang-dao-nin-de-github-zhang-hu) 将 GitBook 应用安装到您的 GitHub 帐户 如果您尚未这样做，您会看到提示将 [GitBook 应用](https://github.com/apps/gitbook-com) 添加到您的 GitHub 帐户。 按照 GitHub 弹窗中的说明，视需要为 GitBook 授予特定仓库权限，或允许访问所有仓库。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-github-sync#xuan-ze-cang-ku-he-fen-zhi) 选择仓库和分支 选择您希望与 GitBook 内容保持同步的帐户和仓库。 **看不到您的仓库？** 如果您在列表中找不到仓库，请确认您已在正确范围内安装了 [GitBook GitHub 应用](https://github.com/apps/gitbook-com) （例如：安装在您的个人帐户或仓库所在的 GitHub 组织中）。您还应检查是否在 GitBook GitHub 应用中配置了正确的仓库访问权限。 选择正确的仓库后，选择要将提交推送到并从中同步的分支。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-github-sync#zhi-xing-chu-shi-tong-bu) 执行初始同步 首次同步时，您可以选择以下两种方向之一进行同步： 1. Git**Book** -> Git**Hub** 将同步您空间的内容 **到** 所选分支。如果您从一个空仓库开始并希望快速将 GitBook 内容导入，这是很好的选择。 2. Git**Hub** -> Git**Book** 将同步您空间的内容 **从** 所选分支。如果您的仓库中已有现成的 Markdown 内容并希望将其导入到 GitBook，这是很好的选择。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/enabling-github-sync#bian-xie-bing-ti-jiao) 编写并提交 您可以开始了。您会注意到如果您的空间处于 [实时编辑](https://gitbook.com/docs/documentation/zh/xie-zuo/live-edits) 模式，实时编辑现在已被锁定。这使我们能够在团队中有人合并 [变更请求](https://gitbook.com/docs/documentation/zh/xie-zuo/change-requests) 到 GitBook 时可靠地将内容同步到您的仓库。 当您在 GitBook 上编辑时，每次变更请求合并都会导致对您所选 GitHub 分支的提交。 当您向 GitHub 提交时，每次提交都会以历史提交的形式同步到您的 GitBook 空间。 为我们的 GitHub 集成提供支持的 GitHub 应用当前无法在 GitHub Enterprise Server 实例上为客户提供。 最后更新于5个月前 这有帮助吗？ --- # GitHub 拉取请求预览 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 当您向已与 GitBook 空间同步的 GitHub 分支提交拉取请求（PR）时，您可以在合并前预览内容。这使您能够在合并更改之前检查其影响。 您可以使用此功能在合并 PR 之前进行最后一层检查，从而在将更改合并到已同步分支之前，在非生产环境中查看这些更改。 #### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/github-pull-request-preview#ru-he-fang-wen-yu-lan-lian-jie) 如何访问预览链接 只要您已授予 [GitBook GitHub 应用](https://github.com/apps/gitbook-com) 对 PR 的必要只读权限，此功能即可开箱即用。 对于每个使用与 GitBook 空间同步的目标分支创建的 PR，您都会在 PR 上看到添加的状态以及唯一的预览 URL。单击 **详细信息** 状态上的链接将带您到内容的预览 URL。然后您可以在合并 PR 之前确认内容是否符合预期。 预览链接仅对具有 GitBook 帐户的用户可访问。 #### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/github-pull-request-preview#an-quan-zhu-yi-shi-xiang) 安全注意事项 出于安全原因，默认情况下 GitBook 目前不会为从您仓库的 fork 打开的 PR 生成预览。由于 PR 预览的内容会在您自己的域名下可访问，无论是在 `.gitbook.io` 还是您的自定义域名下，用户都可能在您公开仓库的 fork 中生成恶意内容并以您的名义进行发布。 我们允许用户通过 Git 同步设置中的一个选项显式配置此行为。 最后更新于5个月前 这有帮助吗？ --- # 单一仓库（Monorepos） | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 GitBook 支持 monorepo。monorepo 是包含多个逻辑项目（例如 iOS 客户端和 Web 应用）的仓库。 GitBook 可以将同一仓库的多个目录与多个空间同步。在为某个空间启用 Git 同步时，你可以配置“项目目录”。它将用于查找 `.gitbook.yaml` 用于与此空间同步的目录的文件。 仓库结构示例： 复制 / package.json packages/ styleguide/ .gitbook.yaml README.md SUMMARY.md app/ README.md SUMMARY.md api/ .gitbook.yaml README.md SUMMARY.md 在此示例中，可以在 GitBook 上创建 3 个空间并配置为不同的根目录： * `packages/styleguide` * `packages/app` * `packages/api` Git 同步级别的“项目目录”选项不同于 [`root` 选项](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration#root) 在 `.gitbook.yaml` 配置文件。第一个用于查找 `.gitbook.yaml` 本身，然后两者结合用于查找目录中的其他文件。如果在“项目目录”中不存在 `.gitbook.yaml` 则同步将使用作用于该目录的默认配置。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/monorepos#updating) 更新项目目录 -------------------------------------------------------------------------------------------- 在大多数情况下，我们建议采取以下步骤来更新项目目录： 1. 禁用现有的 Git 同步 2. 将 Git 仓库中的文件移动到项目目录 3. 使用新的项目目录重新配置 Git 同步 在某些情况下，你可能最初使用典型仓库仅与一个空间同步，但随后决定转换为一个具有多个同步空间的 monorepo；或者可能需要重命名项目目录。 在现有 Git 同步上更改项目目录可能会对内容产生意外影响，该更改仅会在下次同步期间传播（在 GitBook 上的编辑或 Git 仓库中的新提交）。 #### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/monorepos#ru-guo-xia-yi-bu-cao-zuo-shi-cong-git-cang-ku-dao-ru) **如果下一步操作是从 Git 仓库导入**: GitBook 将期望在项目目录中找到页面和文件。如果文件尚未被移动到仓库的项目目录中，则同步的结果可能是一个没有内容的空空间。 我们建议下一步操作为提交，将所有与 GitBook 相关的文件（Markdown 文件、README/SUMMARY 和资源）从仓库移动到其在项目目录中的正确新位置。 **如果下一步操作是从 GitBook 导出到 Git 仓库**: GitBook 将在新的项目目录中生成或更新新文件。与 GitBook 同步的文件将被移动到新的项目目录（会尽最大努力）；如果系统的其他部分依赖这些文件，可能会产生副作用。 最后更新于11个月前 这有帮助吗？ --- # 提交消息与自动链接 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 默认情况下，当从 GitBook 导出内容到 Git 仓库时，GitBook 会基于已合并的变更请求生成提交信息： 复制 GITBOOK-14：改进有关用户管理的文档 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/commits#zi-dong-lian-jie-gitbooknum-zai-github-he-gitlab-zhong) 自动链接 `GITBOOK-` 在 GitHub 和 GitLab 中 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 如果您想在提交中将 GitBook 变更请求 ID（例如）自动解析为链接， _GITBOOK-123_您可以使用 GitHub 的以下功能启用此项： _自动链接引用_ 功能。请参阅以下说明： [GitHub](https://help.github.com/en/github/administering-a-repository/configuring-autolinks-to-reference-external-resources) . 使用下面的 URL 格式，其中 `spaceId` 对应您空间的 URL： `/` ![A GitBook screenshot showing autolink setup](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FjO7dbfEXH6FAOCYaRC6C%252Fgitsync-autolink.svg%3Falt%3Dmedia%26token%3Dce19fb47-bea5-4627-95f1-ac66c7cd91be&width=768&dpr=4&quality=100&sign=cd647403&sv=2) 自动链接设置。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/commits#zi-ding-yi-ti-jiao-xin-xi-mu-ban) 自定义提交信息模板 --------------------------------------------------------------------------------------------------------------------- 在将 GitBook 与 [单体仓库（monorepo）](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/monorepos) 一起使用，或者当您对提交信息有特定指南时，您可能希望自定义 GitBook 在推送提交到 Git 时使用的消息。 模板可以包含以下占位符： * `{change_request_number}` 变更请求的唯一数字 ID * `{change_request_subject}` 合并时变更请求的主题，或 `无主题` 如果未提供主题。 默认模板为： 复制 GITBOOK-{change_request_number}：{change_request_subject} 最后更新于5个月前 这有帮助吗？ --- # 内容配置 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 如果你想进一步配置 Git Sync，你可以添加一个 `.gitbook.yaml` 文件到你仓库的根目录，以告诉 GitBook 如何解析你的 Git 仓库。 .gitbook.yaml 复制 root: ./ structure: readme: README.md summary: SUMMARY.md redirects: previous/page: new-folder/page.md ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration#gen-mu-lu) 根目录 用于查找文档的路径默认是仓库的根目录。以下是告诉 GitBook 去查看 `./docs` 文件夹的方法： .gitbook.yaml 复制 root: ./docs/ **所有其他指定路径的选项都将相对于此根文件夹**。因此，如果你将 root 定义为 `./docs/` ，然后将 `structure.summary` 设置为 `./product/SUMMARY.md`，GitBook 实际上会在 `./docs/product/SUMMARY.md`查找文件。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration#structure) Structure structure 接受两个属性： * `**readme**`: 你的文档首页。其默认值为 `./README.md` * `**summary**`: 你的文档目录（Table of Contents）。其默认值为 `./SUMMARY.md` 这些属性的值是对应文件的路径。该路径相对于“root”选项。例如，以下是告诉 GitBook 去查看 `./product` 文件夹中的首页和目录的方法： .gitbook.yaml 复制 structure: readme: ./product/README.md summary: ./product/SUMMARY.md 启用 Git Sync 时， **请记住不要创建或修改 readme 文件** 通过 GitBook 的界面进行操作。为避免冲突和重复，readme 文件应仅在你的 GitHub/GitLab 仓库中进行管理。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration#summary) Summary 该 `summary` 文件是一个 Markdown 文件（`.md`），应具有以下结构： ./SUMMARY.md 复制 # Summary ## 使用标题创建类似这样的页面分组 * [首页标题](page1/README.md) * [某个子页面](page1/page1-1.md) * [另一个子页面](part1/page1-2.md) * [第二页的标题](page2/README.md) * [某个子页面](page2/page2-1.md) * [另一个子页面](part2/page2-2.md) ## 第二个页面分组 * [另一个页面](another-page.md) 提供自定义的 summary 文件是可选的。默认情况下，GitBook 会查找名为 `SUMMARY.md` 的文件，位于你的 `root` 文件夹（如果在配置文件中指定），否则位于仓库根目录。 如果你未指定 summary，且 GitBook 也没有在文档根目录找到 `SUMMARY.md` 文件，GitBook 将根据文件夹结构和下面的 Markdown 文件来推断目录。 summary Markdown 文件是 **你 GitBook 空间** **目录（Table of Contents）** 的镜像。因此，即使在初始导入时未提供 summary 文件，GitBook 也会在你使用 GitBook 编辑器更新内容时创建并/或更新它。 因此，在你的 `SUMMARY.md` 文件中无法两次引用同一个 Markdown 文件，因为这意味着同一页面在你的 GitBook 空间中会对应两个不同的 URL。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration#redirects) Redirects 重定向允许你在 `.gitbook.yaml` 配置文件中定义重定向。路径相对于“root”选项。例如，以下是告诉 GitBook 将访问旧网址的用户 `/help` 重定向到新网址 `/support` .gitbook.yaml 复制 root: ./ redirects: help: support.md 你在空间配置文件中定义的重定向只作用于对应的空间。我们建议在大多数情况下创建 [站点重定向](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-redirects) ，因为它们适用于整个站点，跨越多个空间。 在 Git 中，当一个文件被多次移动时，原文件会被删除并创建一个新文件。例如，这使得 GitBook 无法知道某个文件夹已被重命名。请务必仔细检查并在需要的地方添加重定向。 最后更新于4个月前 这有帮助吗？ --- # 内容结构 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您在 GitBook 中内容的结构通过页面、空间和集合来组织。页面位于空间内，集合是空间的分组。 [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FtI39XPmv1U3i3pi5jEb6%252FSpaces.svg%3Falt%3Dmedia%26token%3D18f50845-c4ac-4a3e-97da-e5f8d86c2ab9&width=490&dpr=4&quality=100&sign=8df6c2be&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaioaUomEaVXLHnztHl6p%252FSpaces.svg%3Falt%3Dmedia%26token%3D8e2d19bb-6037-411a-9cc9-ad2562ae2480&width=490&dpr=4&quality=100&sign=35d82940&sv=2) **空间** 创建一个空间以将您的文档集中组织在一个地方。 [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FTzBQqRNomT4zDhJQrVWA%252FPages.svg%3Falt%3Dmedia%26token%3Df95884b2-d5c2-4e56-b8aa-3f740fe7339a&width=490&dpr=4&quality=100&sign=62ac991&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FV3Dor3wjPo7hOX4JHqgP%252FPages.svg%3Falt%3Dmedia%26token%3D25561773-a6af-49f8-8986-c5fd14dd2fbf&width=490&dpr=4&quality=100&sign=6fec075c&sv=2) **页面** 创建页面以拆分并编辑文档中的内容。 [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FZp4Dks8VIpDY7WQfndZE%252FCollections.svg%3Falt%3Dmedia%26token%3D2a10a422-1924-47b3-9a7b-cf02f24fc03d&width=490&dpr=4&quality=100&sign=1d365392&sv=2)![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FBpIntuPZEbiWH4iBFRhp%252FCollections.svg%3Falt%3Dmedia%26token%3Dd83320e4-7939-4117-889c-3603993aa8ac&width=490&dpr=4&quality=100&sign=ed7871be&sv=2) **集合** 创建集合以将空间分组在一起。 最后更新于2个月前 这有帮助吗？ --- # 格式化您的内容 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 要格式化文本，只需选择要修改的单词，然后从上下文菜单中选择一种格式——或使用键盘快捷键或通过 Markdown 语法来格式化文本。 我们使用 Mac 键来编写这些快捷键。使用 **Control（控制键）** 代替 **⌘（Command）** 在 Windows 或 Linux 操作系统上。查看我们的 [键盘快捷键](https://gitbook.com/docs/documentation/zh/zi-yuan/keyboard-shortcuts) 部分以查看所有操作系统的全部快捷键。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#jia-cu) 加粗 键盘快捷键： ⌘ + B Markdown 复制 **加粗** ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#xie-ti) 斜体 键盘快捷键： ⌘ + I Markdown 复制 _斜体_ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#shan-chu-xian) 删除线 键盘快捷键： ⇧ + ⌘ + S Markdown 复制 ~~删除线~~ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#dai-ma) 代码 键盘快捷键： ⌘ + E Markdown 复制 `代码` ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#lian-jie) 链接 键盘快捷键： ⌘ + K 当你向页面文本添加链接时，系统会提示你提供链接。你可以添加任何 URL，但如果你要链接到空间中的另一个页面或部分，我们建议 [使用相对链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#relative-links) . 这是 [一个指向外部页面的链接](https://www.gitbook.com/) . 这是一个 [指向该空间中另一页面的链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks) . 这是一个 [指向本页某个部分的链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#code) . 这是 [用于启动发送邮件到特定地址的链接](mailto:support@gitbook.com) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting#wen-zi-yan-se-he-bei-jing-yan-se) 文字颜色和背景颜色 点击上下文菜单中的颜色图标，然后为文本或其背景选择一种颜色。 这段文本是橙色的。 这段文本的背景是橙色的。 最后更新于2个月前 这有帮助吗？ --- # 段落 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 段落是您在 GitBook 上可以使用的最基本的内容块。 您可以 [向段落中添加其他内联内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline) 例如表情符号、图片以及数学与 TeX。 您还可以 [格式化您的文本](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting) 使用上下文菜单或键盘快捷键，或使用 [Markdown](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/paragraph#duan-luo-shi-li) 段落示例 用英文印刷的专业资料通常不会缩进第一段，但会缩进随后的段落。例如，Robert Bringhurst 认为我们应该“将开头段落左对齐”。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/paragraph#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 因为段落块只是文本，所以在 Markdown 中就是这样表示的。 复制 用英文印刷的专业资料通常不会缩进第一段，但会缩进随后的段落。例如，Robert Bringhurst 认为我们应该“将开头段落左对齐”。 最后更新于11个月前 这有帮助吗？ --- # 任务列表 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 任务列表允许您创建带有复选框的项目列表，您可以勾选或取消勾选这些复选框。 **注意：** 已发布空间的读者将无法勾选或取消勾选这些框。您可以在创建内容时决定哪些框被勾选或未勾选。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/task-list#ren-wu-lie-biao-shi-li) 任务列表示例 * 这是一个尚未完成的任务 * 这是一个已完成的子任务，使用缩进 `Tab`. * 这是一个尚未完成的子任务。 * 最后，一个未缩进的项目，使用 `shift 键` + `tab 键`. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/task-list#zai-markdown-zhong-de-biao-shi) 在 markdown 中的表示 复制 - [ ] 这是一个尚未完成的任务 - [x] 这是一个已完成的子任务，使用 `tab` 缩进 - [ ] 这是一个尚未完成的子任务。 - [ ] 最后，一个未缩进的项目，使用 `shift` + `tab`。 最后更新于11个月前 这有帮助吗？ --- # 空间 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 Space 是一个项目，允许您在一组相关页面上工作。它们让您撰写内容、组织页面、添加集成等。 ![A GitBook screenshot showing the spaces sidebar](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FeN7hvBtq9yBRKTYSFIhJ%252Fcreating-content-content-structure-space.svg%3Falt%3Dmedia%26token%3Da3200f81-cd51-4662-b210-ed5c3215222c&width=768&dpr=4&quality=100&sign=ffc0815f&sv=2) ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space#chuang-jian-space) 创建 Space 点击 **+** 位于侧边栏中 **Spaces** 标题旁的按钮并选择 **新建 space** 以创建一个新 Space。您也可以在一个 [集合](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection) . 中创建新 Space。您可以通过将鼠标悬停在 [Space 标题](https://gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#space-header) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space#shang-lai-bian-ji-space-de-ming-cheng) 上来编辑 Space 的名称 复制 Space **要复制 Space，请打开该 Space 在侧边栏的** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 操作 菜单 **并选择**. 复制 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space#fu-zhi-space-jiang-zai-xiang-tong-wei-zhi-zu-zhi-ji-he-zi-ji-he-deng-chuang-jian-yuan-space-de-fu-be) 复制 Space 将在相同位置（组织、集合、子集合等）创建源 Space 的副本。 移动 Space **要复制 Space，请打开该 Space 在侧边栏的** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 您可以通过打开 Space 在侧边栏的 **，选择** 将 Space 移动到… [并选择目标。或者，您也可以在侧边栏中拖放 Space 来移动或重新排序它们。 只要您具有](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/member-management/roles) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space#guan-li-yuan-jue-se) 管理员 角色 ，就可以在同一组织内的集合之间移动 Space。 **要复制 Space，请打开该 Space 在侧边栏的** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 删除 Space **您可以通过打开 Space 在侧边栏的**. **并选择**删除 最后更新于1个月前 这有帮助吗？ --- # 集合 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 集合是将空间分组以便更容易组织内容的一种方式。使用集合，您可以： * 按相似主题或想法组织您的内容 * 管理空间 [权限](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/member-management/permissions-and-inheritance) 通过允许您覆盖组织级别的默认设置来实现大规模管理。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection#chuang-jian-ji-he) 创建集合 点击 **+** 按钮，位于……旁边 **空间** 侧栏中的标题以创建新集合。您也可以从集合的主页面在另一个集合中创建集合或空间。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection#yi-dong-ji-he) 移动集合 您可以通过打开 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2)，选择 **将集合移动到…** 并选择目的地来移动集合。或者，您可以在侧栏中拖放集合以移动或重新排序它们。 您可以将集合移动到其他集合中——如果您在两个组织中拥有 [管理员角色](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/member-management/roles) ，甚至可以移动到其他组织。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection#qian-tao-ji-he) 嵌套集合 您可以将集合彼此嵌套，创建 集合 -> 子集合 -> 空间 的层级结构。 打开一个集合，您可以点击 **新建集合** 从该集合的主页面创建子集合。 要将一个集合移动到另一个集合，点击 **将集合移动到…** 来自该集合的 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 然后选择其新位置。或者，您可以将该集合拖放到新位置。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection#ru-he-shan-chu-ji-he) 如何删除集合 您可以通过打开其 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并选择 **删除**. **删除集合是不可逆的**，但被删除集合内的空间将移至 **回收站** 并且可以在删除后七天内恢复。您可以从侧栏底部访问回收站。 最后更新于5个月前 这有帮助吗？ --- # 有序列表 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 有序列表，也称为编号列表，可帮助您对项目进行优先排序或创建步骤列表。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/ordered-list#you-xu-lie-biao-shi-li) 有序列表示例 1. 项目 1 1. 嵌套项目 1.1 1. 嵌套项目 1.1.1 2. 嵌套项目 1.2 2. 项目 2 3. 项目 3 要创建嵌套项目，您可以使用 **Tab** 用于缩进，和 **⇧ + Tab** 用于减少缩进。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/ordered-list#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 1. 项目 1 1. 嵌套项目 1.1 1. 嵌套项目 1.1.1 2. 嵌套项目 1.2 2. 项目 2 3. 项目 3 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/ordered-list#xiang-you-xu-lie-biao-tian-jia-nei-lian-tu-xiang) 向有序列表添加内联图像 在 GitBook 中可以在有序列表中添加图像 如果您想在有序列表中添加图像，请使用插入菜单添加图像，然后在图像下方的行输入 `3.` 然后按下 `空格`，有序列表将继续。 1. 项目 1 2. 项目 2 ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FFduOhhJv1OXwe96Dhu7L%252F14_03_25_site_sections_published.jpg%3Falt%3Dmedia%26token%3Da4e6f422-0e0f-4e3c-a676-c71fd8e4da7a&width=300&dpr=4&quality=100&sign=990bc83c&sv=2) 1. 项目 3 2. 项目 4 最后更新于10个月前 这有帮助吗？ --- # Markdown | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ![An image containing the markdown logo](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FmrxwTHo6a6LIqMcjZAAt%252Fcreating-content-markdown.svg%3Falt%3Dmedia%26token%3D4ea21c75-f935-4f63-ba3a-e6ede94e3951&width=768&dpr=4&quality=100&sign=cf7fba2d&sv=2) 在 GitBook 中编写 Markdown。 GitBook 的编辑器允许你使用 Markdown 创建格式化内容。 Markdown 是一种以简洁著称的流行标记语法。GitBook 支持它作为一种便于键盘输入的方式来编写富文本和结构化文本。 你可以通过访问以下内容了解更多关于 Markdown 本身的信息 [Common Mark](https://commonmark.org/help/) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#text-formatting) 文本格式化 GitBook 支持所有经典的行内 Markdown 格式： 格式 Markdown 版本 结果 加粗 `**bold**` **bold** 斜体 `_italic_` _italic_ 删除线 `~strikethrough~` ~strikethrough~ 行内代码 `` `code` `` `code` ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#nian-tie-markdown) 粘贴 Markdown 当直接将 Markdown 内容粘贴到编辑器中时，重要的是使用 **粘贴并匹配样式** 选项（通常是 Shift + Cmd + V 在 Mac 上或 Shift + Ctrl + V 在 Windows 上）。 如果你对从其他编辑器或网页复制的内容使用常规粘贴选项，可能会将其作为代码块插入，而不是格式化的文本。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#biao-ti) 标题 * 一级标题： `# 一级标题` * 二级标题： `## 二级标题` * 三级标题： `### 三级标题` ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#dai-ma-kuai) 代码块 ` ```⏎ ` 会创建一个新的代码块。 ` ```py⏎ ` 会创建一个带有 Python 语法高亮的新代码块。 我们使用 [Prism](https://github.com/PrismJS/prism) 来进行语法高亮。你可以使用 [测试 Prism](https://prismjs.com/test.html#language=markup) 来检查 Prism 支持哪些语言。如果你发现 GitBook 与 Prism 之间存在不匹配的情况，可能是我们落后了一个或两个版本。我们会尽快跟上！ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#lie-biao) 列表 GitBook 会在你输入时自动检测并创建有序和无序列表。 * 以 `-` 或 `*` 开头一行以开始无序项目符号列表。 * 以 `1.` 以 * 以 `- [ ]` 开头以开始编号列表。 以 `开头以开始任务列表。` 在编写任何类型的列表时，按下 `Tab` 可以增加缩进，按 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#shifttab) Shift+Tab 以 `>` 可以减少缩进。 `>` 引用 > 以 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown#chuang-jian-kuai-yin-yong-ru-guo-ni-cong-tou-dao-wei-xuan-ze-zheng-duan-wen-zi-shu-ru) 创建块引用。如果你从头到尾选择整段文字，输入 将把内容包裹在块引用中。 `---` 这是一段块引用。 `分隔线` 输入 * * * 然后按下 最后更新于1个月前 这有帮助吗？ --- # 无序列表 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 无序列表非常适合用于列出一系列不需要特定顺序陈述的要点。它们实际上是项目符号列表，并根据需要支持嵌套。 在 GitBook 中输入列表时，按下可以退出列表并在下面开始一个新的空块 `回车` 两次。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/unordered-list#wu-xu-lie-biao-shi-li) 无序列表示例 * 项目 * 嵌套项目 * 另一个嵌套项目 * 再一个嵌套项目 * 另一个项目 * 再一个项目 要创建嵌套项目，您可以使用 **Tab** 用于缩进，和 **⇧ + Tab** 用于减少缩进。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/unordered-list#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 - 项目 - 嵌套项目 - 另一个嵌套项目 - 再一个嵌套项目 - 另一个项目 - 再一个项目 最后更新于1年前 这有帮助吗？ --- # 区块 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 GitBook 是一个基于区块的编辑器，这意味着你可以向内容中添加不同类型的区块——从标准文本和图像到交互式区块。你的页面可以包含任意组合的区块，且页面上的区块数量没有限制。 ![A GitBook screenshot showing the available content blocks](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FMznFq7FlIn7aPdPMpiY5%252Fcreating-content-blocks.svg%3Falt%3Dmedia%26token%3D1cbf2ed0-893f-4f95-b963-3dc2943354a6&width=768&dpr=4&quality=100&sign=bd00f492&sv=2) GitBook 内置的内容区块。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#cha-ru-xin-de-nei-rong-qu-kuai) 插入新的内容区块 你可以使用鼠标在现有区块下方插入新的内容区块： 1. 将鼠标悬停在需要插入新内容区块的位置上方的区块上。 2. 点击 `+` 出现在左侧的图标以打开插入面板。 3. 从下拉菜单中选择你想要的区块以插入它。 或者，在新的一行上，你可以按下 `/` 以启动插入面板，该面板列出所有可用区块。你可以滚动列表以找到想要的区块，或使用键盘搜索要查找的区块、上下导航列表，并使用 `回车`. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#tui-chu-qu-kuai) 退出区块 有些内容区块会捕获编辑光标，以便你在该区块的上下文中添加内容。例如，当你在 [提示区块中](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/hint) 时，按下 `回车` 会在提示区块内添加新行，而不是在下方添加新段落。 完成后，你可以继续向页面添加新内容，方法是使用位于内容左侧的 `+` 按钮插入新区块，或按下 **⌘ + Enter** 在 Mac 上，或按下 **Ctrl + Enter** 在 PC 上。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#xuan-ze-qu-kuai-bing-yu-suo-xuan-qu-kuai-jiao-hu) 选择区块并与所选区块交互 你可以将光标放在区块内并按下 `Esc` 键来选择单个区块。你也可以通过高亮其中的内容并按下来选择多个区块， `Esc`. 选中后，你可以： * 在按住 **Shift ⇧** 键的同时，通过点击来选择更多区块。 * 使用 **↑** 并且 **↓** 键上下移动以选择上方或下方的区块。 * 使用以下方式复制整个区块： **⌘ + C** （Mac）或 **Ctrl + C** （Windows） * 使用以下方式剪切整个区块： **⌘ + X** （Mac）或 **Ctrl + X** （Windows） * 使用以下方式删除所选的区块或区块组： **⌫** 或 **Del**. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#quan-kuan-qu-kuai) 全宽区块 通过将区块设置为全宽，你可以在内容中创建清晰的视觉层次，或为需要更多空间的内容提供更大的展示区域。 要将区块设为全宽，点击区块旁的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择 **全宽**。此功能适用于以下区块类型： * 代码区块 * 图像块 * 表格 * 卡片 * API 区块 * 集成区块 * 列 最后更新于5个月前 这有帮助吗？ --- # 标题 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 标题有助于为您的文档提供结构 —— 在标题中使用关键词也会帮助搜索引擎理解该结构，这可以提升您页面在搜索结果中的排名。 GitBook 提供三级标题。标题级别 1 (H1) 和 2 (H2) 将出现在 [页面大纲](https://gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#page-outline) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#mao-dian-lian-jie) 锚点链接 当您向页面添加标题时，会创建一个锚点链接。然后您可以直接链接到这些特定部分，以便将人们指向相关信息。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#lian-jie-dao-mao-dian) 链接到锚点 您可以在公共内容中，或以只读模式查看的私有内容中，通过将鼠标悬停在标题上并点击 `#` 出现在其旁边的图标来查看锚点链接。此操作会更新浏览器顶部栏中的 URL，您可以复制以在其他地方使用。 如果您想从 GitBook 空间内的某个页面链接到特定锚点，您可以使用 [相对链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#relative-links) ，如果您更改标题，该链接会更新以防止链接断开。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#bian-ji-mao-dian) 编辑锚点 默认情况下，锚点链接将与标题文本相同。如果您打算在 GitBook 外部链接到该 URL，日后更改标题会导致锚点链接失效。链接将把访问者带到页面顶部，而不是锚点位置。 为避免这种情况，您可以手动设置锚点链接，方法是打开标题的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 菜单，然后选择 **编辑锚点**。然后您可以输入希望使用的锚点链接 —— 即使您更改标题本身，该锚点也会保持不变。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 GitBook 生成经过 SEO 优化的页面，这意味着 GitBook 中的页面标题会自动在 markdown 中表示为一级标题： 复制 # 我是页面标题 这意味着如果您 [将内容与 Git 同步](https://gitbook.com/docs/documentation/zh/ru-men/git-sync) ，通过编辑器添加的页面标题将在 markdown 中降低一级表示： 复制 ## 我的标题 1 ### 我的标题 2 #### 我的标题 3 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#example-of-a-heading) 标题示例 [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#wo-de-biao-ti-1) 我的标题 1 ------------------------------------------------------------------------------------------------------------- ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#wo-de-biao-ti-2) 我的标题 2 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading#wo-de-biao-ti-3) 我的标题 3 最后更新于4个月前 这有帮助吗？ --- # 引用 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 当您想引用来自其他来源的内容时，引语很有用。 通过键入来开始引用 `>` 随后按下 `空格` 在空段落中，或使用 [插入面板](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#inserting-a-new-content-block) 。您也可以通过突出整个段落并按下将段落块转换为引用 `>`. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/quote#yin-yong-shi-li) 引用示例 > “没有人两次踏入同一条河流，因为那已不是同一条河流，他们也不再是同一个人。” — _赫拉克利特_ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/quote#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 > “没有人两次踏入同一条河流，因为那已不是同一条河流，他们也不再是同一个人。” — _赫拉克利特_ 最后更新于1年前 这有帮助吗？ --- # 故障排除 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#i-have-a-github-sync-error) 我遇到了 GitHub 同步错误 ------------------------------------------------------------------------------------------------------------------------------ ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#qing-que-bao-zhi-zai-ni-de-cang-ku-zhong-chuang-jian-readme-wen-jian) 请确保只在你的仓库中创建 README 文件 启用 Git 同步时，请注意不要通过 GitBook UI 创建 README 文件。通过 GitBook UI 创建 README 文件会： * 在你的仓库中创建重复的 README 文件 * 导致 GitBook 与 GitHub 之间的渲染冲突 * 可能破坏构建和部署流程 * 导致不可预测的文件优先级 这包括名为 README.md、readme.md、Readme.md 和不带扩展名的 README 的文件。相反，请记得直接在你的 git 仓库中管理你的 README 文件。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#reng-ran-yu-dao-cuo-wu) 仍然遇到错误？ 请确保： * 你的仓库 **在根目录有一个** `README.md` **文件** （或在 `root` 中指定的文件夹）直接在你的 git 仓库中创建。该文件是必需的，并用作文档的首页。更多细节请参阅我们的 `.gitbook.yaml`内容配置 [如果你的 Markdown 文件中有 YAML frontmatter，请使用](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration) . * 检查器 [以确保它们有效。](http://www.yamllint.com/) 。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#gitbook-is-not-using-my-docs-folder) GitBook 没有使用我的 `docs` 文件夹 ------------------------------------------------------------------------------------------------------------------------------------------------ 默认情况下，GitBook 使用仓库根目录作为起点。可以指定特定目录以限定 Markdown 文件。有关更多信息，请查看我们的 [如果你的 Markdown 文件中有 YAML frontmatter，请使用](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration) 文档。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#gitbook-is-creating-new-markdown-files) GitBook 正在创建新的 Markdown 文件 ---------------------------------------------------------------------------------------------------------------------------------------------------- **当从 GitBook 与已有的 Git 仓库同步并编辑时，** GitBook 可能会创建新的 Markdown 文件而不是使用已有文件。这么做是为了确保 GitBook 不会覆盖在你仓库中已有的文件。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#zhong-ding-xiang-wu-fa-zheng-que-gong-zuo) 重定向无法正确工作 -------------------------------------------------------------------------------------------------------------------------------------- YAML 文件需要正确格式化，重定向才能生效。诸如缩进或空格错误可能导致重定向无法工作。 [验证你的 YAML 文件](https://www.yamllint.com/) 可以确保重定向顺利工作。 设置重定向时，不要添加任何前导斜杠。例如，尝试重定向到 `./misc/support.md` 将无法工作。 还需要注意的是，只要某个路径对应的页面存在，GitBook 就不会去查找可能的重定向。因此，如果你为旧页面设置重定向到新页面，需要删除旧页面，重定向才能生效。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#my-repository-is-not-listed) 我的仓库未列出 ---------------------------------------------------------------------------------------------------------------------- ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#zhen-dui-github-cang-ku) 针对 GitHub 仓库 请确保你已将 GitBook GitHub 应用安装到正确的位置（安装应用时，你可以选择安装到个人 GitHub，或安装到你有权限的任何组织），并且已授予该应用正确的仓库权限。 ### [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#zhen-dui-gitlab-cang-ku) 针对 GitLab 仓库 请确保你的访问令牌已配置以下访问权限： * `api` * `read_repository` * `write_repository` [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#nothing-happens-on-gitbook-after-adding-a-new-file-to-my-repository) 在将新文件添加到我的仓库后，GitBook 没有任何反应 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **本节特别针对以下情况的问题， 当一个** `**SUMMARY.md**` **文件已存在** 如果你的仓库不包含一个 `SUMMARY.md` 文件，GitBook 会在第一次同步时自动创建一个。这意味着如果在设置 Git 同步后你至少在 GitBook 上编辑过一次内容，GitBook 应该已经自动创建了该文件。 如果在通过向仓库添加或修改 Markdown 文件更新仓库后，你没有在 GitBook 上看到更新，且侧边栏在同步期间未显示错误，你修改的文件可能没有被列在 [你的 `SUMMARY.md` 文件](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/content-configuration#summary) 查找文件。 这可能是因为你手动创建了该文件，或者因为你在 GitBook 上进行了编辑，而同步的 GitBook 到 Git 导出阶段为你创建了它。 该文件的内容镜像你在 GitBook 上的 [目录（Table of Contents）](https://gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#table-of-contents) ，并在同步的 Git 到 GitBook 导入阶段用于重建你的目录并将仓库中即将到来的更新与 GitBook 上现有内容重新对齐。 如果在确认所有文件都包含在 `SUMMARY.md` 文件中后，GitBook 仍然没有任何反应，请随时 [联系支持](https://gitbook.com/docs/help-center/further-help/how-do-i-contact-support) 寻求帮助。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#github-yu-lan-wei-xian-shi) GitHub 预览未显示 -------------------------------------------------------------------------------------------------------------------------- 如果你的 GitHub 预览未显示，可能是因为你的 GitSync 集成是在 2022 年 1 月之前配置的。该日期之前配置的 GitSync 版本不包含 GitHub 预览。 你应该已经收到一条通知，要求你接受更新后的权限请求以启用对 PR 的只读访问。 如果你没有收到该通知，故障排除需要更新到新版本： 1. 从你的组织中卸载 GitSync 集成。 2. 使用更新权限重新安装新版本。 请注意，卸载 GitSync 集成将需要在之前连接过的任何空间上重新配置该集成。 [](https://gitbook.com/docs/documentation/zh/ru-men/git-sync/troubleshooting#deng-lu-shi-ke-neng-chu-xian-chong-fu-zhang-hu) 登录时可能出现重复账户 --------------------------------------------------------------------------------------------------------------------------------------------- 此错误通常发生在用于设置同步的 GitHub 账户已与另一个 GitBook 用户账户关联时。 识别该 GitHub 账户已链接到哪个 GitBook 账户的一个好方法是： 1. 登出你当前的 GitBook 用户会话（例如： `name@email.com`) 2. 登出任何 GitHub 用户会话。 3. 前往 [登录 页面](https://app.gitbook.com/login) . 4. 选择“使用 GitHub 登录”选项。 5. 输入你的 GitHub 凭据。 6. 登录后，前往 [账户设置](https://app.gitbook.com/account) 并执行以下操作之一： 1. 在“第三方登录 > GitHub”部分取消关联该账户（个人设置中） 2. 如果不需要该账户，则彻底删除该账户。 7. 从该会话登出。 8. 使用你的 `name@email.com` GitBook 账户重新登录。 9. 尝试再次设置 Git 同步。 最后更新于5个月前 这有帮助吗？ --- # 提示 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 提示或注释是引导读者关注文档中特定元素（例如提示、警告和其他重要信息）的极好方式。 有四种不同的提示样式 — 你可以通过点击彩色图标或打开区块的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择你想要的样式来更改样式。 提示区块支持 [行内内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline) 并且 [格式化](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting) ，以及一些特定的区块类型。要查看在提示中可以使用哪些区块类型，请在空行上按下 `/` 并检查 [插入面板](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#inserting-a-new-content-block) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/hint#example-of-a-hint) 提示区块示例 **信息提示** 非常适合显示一般信息或提供提示和技巧。 **成功提示** 适用于显示积极的操作或成就。 **警告提示** 适合显示重要信息或非关键性警告。 **危险提示** 适合突出破坏性操作或提醒注意关键性信息。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/hint#zhe-shi-yi-ge-h2-biao-ti) 这是一个 H2 标题 这是一行 这是一段行内 ![The Apple computer command icon](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F0FzoF68PAY3Rv297meNB%252Fcommand.svg%3Falt%3Dmedia%26token%3Db07ff261-6e28-4879-8ab1-039a49f6ab41&width=40&dpr=4&quality=100&sign=eb9a26fa&sv=2) 图像 * 这是第二个 使用无序列表和颜色的行 要在提示中添加标题，需要在提示中将标题区块作为第一个区块创建。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/hint#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 {% hint style="info" %} **信息提示** 非常适合显示一般信息或提供提示和技巧。 {% endhint %} {% hint style="success" %} **成功提示** 适用于显示积极的操作或成就。 {% endhint %} {% hint style="warning" %} **警告提示** 适合显示重要信息或非关键性警告。 {% endhint %} {% hint style="danger" %} **危险提示** 适合突出破坏性操作或提醒注意关键性信息。 {% endhint %} {% hint style="info" %} ## 这是一个 H2 标题 这是一行 这是一张行内 The Apple computer command icon 图像 - 这是第二行 使用无序列表和颜色 {% endhint %} 最后更新于3个月前 这有帮助吗？ --- # 分步器 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 步骤块允许您将教程或指南拆分为独立但明确关联的步骤。每个步骤可以包含多个不同的块，便于您添加详细信息。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper#shi-li) 示例 1 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper#tian-jia-bu-zhou-kuai) 添加步骤块 要添加步骤块，请在空行上按 `/` 或点击编辑器左侧的 `+` 并选择 **步骤器** 从插入菜单中。 2 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper#tian-jia-yi-xie-nei-rong) 添加一些内容 插入步骤块后，您可以开始向其添加内容——包括代码块、绘图、图像等更多内容。 3 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper#tian-jia-geng-duo-bu-zhou) 添加更多步骤 点击 `+` 在步骤编号下方或按 `回车` 两次以向步骤块添加另一个步骤。您可以根据需要删除或更改步骤标题或步骤正文的样式。 [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 ------------------------------------------------------------------------------------------------------------------------------------- 复制 ## 示例 {% stepper %} {% step %} ### 步骤 1 标题 步骤 1 文本 {% endstep %} {% step %} ### 步骤 2 标题 步骤 2 文本 {% endstep %} {% endstepper %} ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper#xian-zhi) 限制 在步骤块内部可以创建的块存在一些限制——例如，您不能添加可展开的块或另一个步骤块。要查看可以添加的所有块，请在步骤块内另起一行并按 `/` 以调出插入面板。 最后更新于1年前 这有帮助吗？ --- # 标签页 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 选项卡块是一个单一的块，具有添加多个选项卡的选项。 每个选项卡可以包含多种其他块，任何类型均可。因此您可以在同一选项卡块的单个选项卡中添加代码块、图片、集成块等。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/tabs#tian-jia-huo-shan-chu-xuan-xiang-ka) 添加或删除选项卡 要向选项卡块添加新选项卡，将鼠标悬停在选项卡的边缘并单击出现的 `+` 按钮。要删除选项卡，请打开该选项卡的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 然后选择 **删除**. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/tabs#shi-li) 示例 下面是列出与特定平台相关说明的示例： Windows macOS Linux 以下是适用于 Windows 的说明 以下是适用于 macOS 的说明 以下是适用于 Linux 的说明 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/tabs#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 {% tabs %} {% tab title="Windows" %} Here are the instructions for Windows {% endtab %} {% tab title="OSX" %} Here are the instructions for macOS {% endtab %} {% tab title="Linux" %} Here are the instructions for Linux {% endtab %} {% endtabs %} 最后更新于5个月前 这有帮助吗？ --- # 嵌入的 URL | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 要添加嵌入的 URL，只需粘贴要嵌入内容的链接并按下 `回车`. **注意：** 要嵌入的内容必须公开可用，以便 GitBook 访问该文件。例如，当嵌入 Google 文档时，共享设置必须设置为 _拥有链接的任何人_. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url#shi-pin) 视频 **注意：** 您可以通过在 YouTube 和 Vimeo 嵌入链接后添加来选择自动播放和循环播放 `?autoplay=1&loop=1` 在视频 URL 的末尾。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url#codepen) Codepen ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url#spotify) Spotify ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url#zai-markdown-zhong-de-biao-shi-fa) 在 Markdown 中的表示法 复制 {% embed url="URL_HERE" %} 最后更新于11个月前 这有帮助吗？ --- # 可展开 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 可展开的区块有助于压缩原本可能很冗长的段落。它们在分步指南和常见问题解答中也很有用。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/expandable#shi-li) 示例 步骤 1：开始使用可展开区块[](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/expandable#bu-zhou-1-kai-shi-shi-yong-ke-zhan-kai-qu-kuai) 要添加可展开区块，按下 `/` 在空白区块上，或点击编辑器左侧的 `+` 并选择 **可展开**. 步骤 2：向你的区块添加内容[](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/expandable#bu-zhou-2-xiang-ni-de-qu-kuai-tian-jia-nei-rong) 插入可展开区块后，你可以向其中添加内容——包括列表和代码区块。 [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/expandable#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 ---------------------------------------------------------------------------------------------------------------------------------------- 复制 # 可展开区块
可展开区块
### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/expandable#xian-zhi) 限制 在可展开区块内部可以创建的区块存在一些限制。你可以通过在可展开区块中开始新一行并按下来查看完整列表 `/` 以调出插入面板。 最后更新于11个月前 这有帮助吗？ --- # 绘图 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以直接在 GitBook 中使用集成的 绘图 或 草图 创建工具， [Excalidraw](https://excalidraw.com/) 编辑器，然后将其直接添加到您的 GitBook 页面中。 要创建绘图，请在 空白 行 按下 `/` 以调出插入面板并选择 **绘图**。这将打开带有 Excalidraw 工具的弹出窗口——完成后只需关闭弹出窗口，您的图表就会出现在 GitBook 页面上。 GitBook 将绘图作为空间中的特殊 SVG 文件存储。那些文件的扩展名为 `drawing.svg`. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/drawing#hui-tu-kuai-shi-li) 绘图块示例 ![Drawing](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FEU4IQ0zVbLLZ2o7ivizA%252Ffile.excalidraw.svg%3Falt%3Dmedia%26token%3D789b9484-cf49-41d7-88ac-61bb1480e85f&width=768&dpr=4&quality=100&sign=35ab062&sv=2) 在 GitBook 中绘制的图表 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/drawing#shi-yong-gitbook-ai-hui-tu) 使用 GitBook AI 绘图 此功能可在以下方案中使用 [专业版与企业版计划](https://www.gitbook.com/pricing) . 在使用绘图块时，您可以通过指定提示让 GitBook AI 生成插图。只需输入提示并按 **生成**，或者选择一个建议的提示开始。 一旦 GitBook AI 完成绘图，您可以双击打开完整的绘图面板并按您喜欢的方式进行编辑。 在编辑绘图时，点击 **使用 AI 生成** 按钮以再次调出 GitBook AI 的提示编辑器并生成新的绘图。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/drawing#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 示例图表描述 最后更新于3个月前 这有帮助吗？ --- # 搜索内部内容 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ![A GitBook screenshot showing the search bar](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FeqdESbrmoMR2WU0gAfG4%252Fcreating-content-searching-content.svg%3Falt%3Dmedia%26token%3D83d18fbb-6c55-4e7d-8a91-7ad088c8c646&width=768&dpr=4&quality=100&sign=4e230804&sv=2) 使用内置搜索栏提问或在内容中搜索。 无论您是在 GitBook 应用中工作，还是访客在阅读您发布的内容，GitBook 的搜索功能都能帮助您轻松找到所需内容。 您可以使用快速查找来搜索特定单词或短语，或者向 GitBook AI 提问。它会在几秒钟内扫描您的文档并总结出答案，同时提供参考以帮助您了解更多信息。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/searching-your-content#quan-ju-sou-suo) 全局搜索 如果您在以下平台上发布文档 [Ultimate 站点计划](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/plans#site-plans) ，并将多个空间添加为 [站点部分](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-structure/site-sections) ，您的用户将能够使用 **提问或搜索** 栏在所有站点部分中查找信息。 最后更新于5个月前 这有帮助吗？ --- # 文件 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以将文件上传到您的 GitBook 空间，并将它们添加到页面供他人查看或下载。 您可以在页面本身显示某些文件，例如图像和 OpenAPI 文件，让人们无需点击即可查看。对于其他文件（例如 PDF），用户需要点击才能查看或下载。 您还可以选择在插入到页面的任何文件下方添加说明文字，以便在需要时提供更多信息。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files#example-of-a-file) 文件示例 2MB [example.pdf](https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-9ff1c1eef1d9ee1744295e274d3ee01fae848a20%2Fexample.pdf?alt=media) PDF 下载[打开](https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-9ff1c1eef1d9ee1744295e274d3ee01fae848a20%2Fexample.pdf?alt=media) 这是文件的说明文字。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files#shang-chuan-wen-jian) 上传文件 您可以在空间的“文件”侧边面板中管理已上传的文件。您可以在空间目录的顶部找到“文件”面板。 要上传文件，请将其拖放到 **放入您的文件或浏览** 部分，或选中该部分并使用系统文件对话框选择要上传的文件。 GitBook 允许您每个文件上传最大 100MB 的文件。 当您添加以下内容时，也可以将文件添加到您的空间： [图像块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images) 或一个 [OpenAPI 块](https://gitbook.com/docs/documentation/zh/api-can-kao/openapi) 。当您创建这些块之一时，文件面板会打开，您可以选择文件或上传新文件。 **提示：** 您也可以直接将图像从文件系统拖放到编辑器中，或将复制的图像粘贴到内容中。GitBook 会自动将它们添加到相应空间的“文件”侧边面板，方便您稍后查看和管理。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files#zhong-ming-ming-wen-jian) 重命名文件 要重命名文件，请打开该文件的 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并点击 **编辑**。在对话框提示中，输入文件的新名称。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files#shan-chu-wen-jian) 删除文件 要删除文件，请打开该文件的 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并点击 **删除**。在对话框中确认您确实要删除该文件后，文件将被删除。 **注意：** 请务必更新包含已删除文件的任何页面！引用已删除文件的文件块将显示为空块，或 _无法加载图像_ 错误。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files#ti-huan-wen-jian) 替换文件 如果某个文件只需要更新为新版本，您可以替换它。这将替换旧文件并将新文件放在其位置。之前引用旧文件的任何块随后将引用新文件。 要替换文件，请打开 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并点击 **替换**。在弹出的文件替换对话框中，选择新文件并等待上传指示完成。您的文件将在空间中出现的所有位置自动更新。 例如，如果您的产品进行了重大重新设计，需要更新出现在多个页面上的过时 UI 截图，这将非常有用。替换原始文件会在空间中的所有地方更新该截图，为您节省时间和精力。 **提示：** 上传图像或文件后，您可以通过创建图像块或文件块并从 **文件** 侧边面板中选择它，在空间中的任何位置引用它。 我们建议您这样做，而不是每次包含图像时都重新上传，以便日后更容易替换图像并避免出现多个同名文件。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 {% file src="https://example.com/example.pdf" %} 这是示例文件的说明文字。 {% endfile %} 最后更新于3个月前 这有帮助吗？ --- # 页面 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 页面是您添加、编辑和嵌入内容的地方。页面始终位于一个 [空间](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space) 内，允许您对相关内容进行分组并为您覆盖的主题或领域创建不同的部分。 在发布文档时，每个空间将成为其自己的 [文档站点](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/publish-a-docs-site) 或 [站点部分](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/site-structure/site-sections) ，空间内的页面都将显示在该站点上。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#mu-lu) 目录 您可以在一个空间中创建任意数量的页面。它们都在屏幕左侧的空间的 [目录](https://gitbook.com/docs/documentation/zh/zi-yuan/gitbook-ui#table-of-contents) 中可见。除非 [您选择隐藏它](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#page-options) . [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#wen-dang-zhan-dian-zhuo-lu-ye) 文档站点着陆页 ------------------------------------------------------------------------------------------------------------------------------------ 目录中的第一页始终是您空间的着陆页，即使它在目录中被隐藏。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#chuang-jian-xin-ye-mian) 创建新页面 在 [实时编辑](https://gitbook.com/docs/documentation/zh/xie-zuo/live-edits) 模式或在一个 [变更请求](https://gitbook.com/docs/documentation/zh/xie-zuo/change-requests) 中，您可以通过点击创建新页面 **添加新内容...** > **页面** 在目录底部。或者，您可以将鼠标悬停在目录中的页面之间，然后点击出现的 **+** 图标。 ![A GitBook screenshot showing an empty page listed in the table of contents](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FKuLZJITi1L5ZEfehKvLF%252F04_02_25_page.svg%3Falt%3Dmedia%26token%3Da6ce2ea9-f655-445b-aade-4269f1733c72&width=768&dpr=4&quality=100&sign=bb34b7fb&sv=2) GitBook 中的一个空页面。您可以在左侧的目录中看到它列出。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#kan-bu-dao-chuang-jian-xin-ye-mian-de-xuan-xiang) 看不到创建新页面的选项？ 如果 [实时编辑](https://gitbook.com/docs/documentation/zh/xie-zuo/live-edits) 已为您的空间禁用，您需要创建或编辑一个 [变更请求](https://gitbook.com/docs/documentation/zh/xie-zuo/change-requests) 。一旦您进入变更请求， **新页面** 按钮（允许您创建页面、页面组和链接）将在目录中可用。 或者，您可能没有正确的 [权限](https://gitbook.com/docs/documentation/zh/zhang-hu-guan-li/member-management/permissions-and-inheritance) 来编辑页面。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#zu-zhi-nin-de-nei-rong) 组织您的内容 在目录中组织内容有三种方式： #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#ye-mian) 页面 页面有标题、可选的描述，以及一个您可以撰写并添加任何类型内容的区域。 您可以通过在目录中将一个页面拖放到另一个页面下方来嵌套页面。这样会创建一个 **子页面**. 如果您向一个空的父页面添加子页面，GitBook 会在发布的文档版本中自动生成一个“内容”页面，其中包含指向所有子页面的链接。 **提示：** 页面嵌套没有限制，但我们建议避免超过三层嵌套，以免导航过于复杂。 当您更改页面标题时，页面的 slug（URL 最末端的部分，例如 `/hello-world`）也会改变——除非您之前已手动设置过页面的 slug。 您可以随时通过点击打开页面的 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并选择 **重命名**. #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#ye-mian-zu) 页面组 通过页面组，您可以将页面聚合到覆盖相关内容的各个部分中。 您可以通过点击在目录底部创建新的页面组 **添加新内容...** > **分组** 。 页面组只能位于目录的 **顶层** 。您不能在页面组内嵌套页面组。 要更改页面组的标题和 slug，请点击目录中组标题旁的 **操作菜单** 图标 ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并选择 **重命名**. #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#external-links) 外部链接 您也可以将链接添加到目录。点击它们会直接将人们带到所链接的内容。 通过点击创建新的外部链接 **添加新内容...** > **外部链接** 。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#ye-mian-tu-biao-he-biao-qing-fu-hao) 页面图标和表情符号 为提高读者在浏览目录时的可见性，您可以为单个页面添加可选的图标或表情符号。该图标或表情符号将出现在目录中，并出现在页面顶部标题旁。 要添加图标或表情符号，请在悬停页面标题时点击 **添加图标** 按钮，或点击标题左侧的表情符号按钮。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#ye-mian-xuan-xiang) 页面选项 在 **页面选项** 菜单中，您可以自定义空间内所选页面的外观和感觉，并控制其可见性。 **布局** 您可以打开 **页面选项** ![The Page options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FAsao5RY8jwAmcYhpVwPI%252Foptions.svg%3Falt%3Dmedia%26token%3Dd962d9a8-0cd6-42e7-a7b7-50c68a74dfea&width=300&dpr=4&quality=100&sign=6ab1fc90&sv=2) 菜单或通过将鼠标悬停在页面标题上来更改页面封面。您会在页面标题上方看到这些按钮出现。 在 **页面选项** 侧边面板中，您可以选择访客访问您已 **发布** 的内容时每个页面的显示方式。有三个布局预设可供选择，或者您可以创建自定义布局。 每个布局预设将切换页面以下各部分的显示与否： * 页面标题 * 页面描述 * 目录 * 页面大纲 * 上一页/下一页 链接 * 页面元数据 您还可以从此菜单设置页面的全局宽度。选择 **宽** 将自动扩展支持 **全宽** 选项的模块——例如表格、卡片和代码块——以在页面发布时为它们提供更多空间。这非常适合创建引人注目的着陆页！ #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#ke-jian-xing) 可见性 您可以决定在已发布的文档中要显示/隐藏哪些页面，同时决定是否希望该页面在已发布文档的搜索中被索引，和/或被搜索引擎索引。 您可以通过打开页面的 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 并切换 **隐藏页面**. 如果隐藏，则在使用 Git 同步时，以下内容将出现在 markdown 文件的 front matter 中： page.md 复制 --- hidden: true --- ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page#ye-mian-feng-mian) 页面封面 您还可以为文档的每个页面设置页面封面。当您点击 **页面封面** ![The Page cover icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FI1Q5rfhHgy0toM2pUEH5%252Fimage.svg%3Falt%3Dmedia%26token%3Da3cf4181-880b-4698-9a1b-1a99f48bb03b&width=300&dpr=4&quality=100&sign=e20fb6be&sv=2) 选项时，将立即添加一个默认封面。从这里，您可以： * **更改封面图片** 将鼠标悬停在页面封面上并点击 **更改封面**，然后选择或上传图片。基于我们当前显示页面封面的方式，1990x480 像素是理想尺寸。 * **重新定位封面图片** 将鼠标悬停在页面封面上并打开 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2)。点击 **重新定位**，然后按需拖动图片并点击 **保存**. * **移除封面图片** 将鼠标悬停在页面封面上并打开 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2)，然后点击 **移除**. * **全宽和英雄宽度** 您可以更改页面封面的样式，使其横跨屏幕的全宽或仅为内容宽度。将鼠标悬停在页面封面上并打开 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2)，然后从菜单中选择您偏好的选项。 最后更新于1个月前 这有帮助吗？ --- # 数学与 TeX | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以使用 mathTeX 格式在文档中包含数学公式。我们通过 [KaTeX](https://katex.org/docs/supported.html) 库 提供此功能。 您也可以将 mathTeX 添加为 [行内内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#math-and-tex) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/math-and-tex#math-yu-tex-qu-kuai-shi-li) Math 与 TeX 区块示例 s\=1N−1∑i\=1N(xi−x‾)2s = \\sqrt{\\frac{1}{N-1} \\sum\_{i=1}^N (x\_i - \\overline{x})^2}s\=N−11​i\=1∑N​(xi​−x)2​ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/math-and-tex#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 f(x)\=x∗e2piiξxf(x) = x \* e^{2 pi i \\xi x}f(x)\=x∗e2piiξx 复制 # Math and TeX block $$f(x) = x * e^{2 pi i \xi x}$$ 最后更新于1年前 这有帮助吗？ --- # 页面链接 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 页面链接块是在内容中不同页面之间创建关联的最佳方式。页面链接以块的形式显示在页面上——与添加到某些文本中的超链接相比，它们占据独立的块。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/page-link#ye-mian-lian-jie-kuai-shi-li) 页面链接块示例 下面的链接指向 [区块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks) 并且 [行内内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline) : [区块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks) [内联内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline) [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/page-link#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 --------------------------------------------------------------------------------------------------------------------------------------- 复制 {% content-ref url="./" %} . {% endcontent-ref %} 最后更新于1年前 这有帮助吗？ --- # 内联内容 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 ![A GitBook screenshot showing inline content options](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FTUAHcyqQIRn7MgF4wUMD%252Fcreating-content-formatting-your-content-inline.svg%3Falt%3Dmedia%26token%3Def5b5f37-0a70-4b4d-9458-61156cd1cd38&width=768&dpr=4&quality=100&sign=7372ed10&sv=2) 向您的内容添加内联元素。 内联调色板允许您在不离开键盘的情况下快速向文本块添加额外内容。只需按下 `/` 在任何文本块上以打开内联调色板。斜杠会被您选择插入的内容替代。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zhu-shi) 注释 使用注释，您可以在不打断读者思路的情况下为文字添加额外的上下文。您可以用它们来解释单词的含义、插入额外信息等。读者可以将鼠标悬停在带注释的文本上以在文本上方显示注释。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#chuang-jian-zhu-shi) 创建注释 要创建注释，请选择您想要注释的文本，然后点击 **注释** 上下文菜单中的选项。写完注释后，单击注释外部即可继续在文本块中写作。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#markdown-biao-shi-fa) Markdown 表示法 您可以将内容写成 [Markdown 脚注](https://www.markdownguide.org/extended-syntax/#footnotes) 以在 GitBook 中将它们添加为注释。脚注指示符应紧跟在您要注释的单词之后；不应出现在标点符号或其他符号之后。 复制 这是一个简单的脚注[^1]，这是一个更长的脚注[^bignote]。 [^1]: 这是第一个脚注。 [^bignote]: 这是一个包含多个段落和代码的脚注。 缩进段落以将它们包含在脚注中。 `{ my code }` 可以添加任意多的段落。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#tu-pian) 图片 内联图片将与页面上的文本并排显示。 默认情况下，图片设置为原始大小，最大宽度为 300px。您可以通过单击图片以打开格式化调色板，然后选择三种选项之一来更改大小： 1. **内联大小：** 图片按字体比例缩放——非常适合图标和徽章。 2. **原始大小：** 图片将以原始大小保持内联，最大宽度为 300 像素。 3. **转换为块：** 这会将内联图片转换为 [图片块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images) ，其宽度与您的内容一样宽。 [图片块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images) 提供更多选项，包括更多尺寸和添加说明的能力——但不会与文本内联显示。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 这是一个内联图片： Dark version of GitBook logo ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#biao-qing-fu-hao) 表情符号 您可以按下 `/` 以打开内联调色板来添加表情符号。或者，输入 `:` ，一列表情符号将直接在行内弹出——您可以开始输入表情符号的名称以缩小选择范围。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zai-markdown-zhong-de-biao-shi-1) 在 Markdown 中的表示 复制 :house: :car: :dog: ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#lian-jie) 链接 您可以插入三种不同类型的链接： * [相对链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#relative-links) * [绝对链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#absolute-links) * [电子邮件地址 `mailto` 链接](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#email-address-mailto-links) #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#xiang-dui-lian-jie) 相对链接 相对链接是通过链接到您空间中已存在的 [页面](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page) 创建的链接。使用相对链接的优点是如果页面的 URL、名称或位置发生更改，其引用会保持更新——因此您会有更少的断链。 下面是插入相对链接的方法： 1. 在段落中单击您想要插入链接的位置，或选择一些文本。 2. 按 / 打开内联调色板并选择链接，点击上下文菜单中的 **链接** 按钮，或按下 **⌘ + K**. 3. 开始输入您要链接的页面标题。 4. 从下拉搜索结果中选择页面。 5. 按下 `回车`. #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#jue-dui-lian-jie) 绝对链接 绝对链接是您可以复制并粘贴到内容中的外部链接。当您想要链接到文档之外的内容时，它们非常有用。 插入绝对链接的方法： 1. 在段落中单击您想要插入链接的位置，或选择一些文本。 2. 按 / 打开内联调色板并选择链接，点击上下文菜单中的 **链接** 按钮，或按下 **⌘ + K**. 3. 粘贴您要链接到的 URL。 4. 按下 `回车`. #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#wei-shen-me-wai-bu-lian-jie-bu-hui-zai-xin-biao-qian-ye-da-kai) 为什么外部链接不会在新标签页打开？ 当您在文档中添加指向外部站点的链接时，它会在同一标签页中打开。 GitBook 遵循这一 [W3C 推荐的行为](https://www.w3.org/TR/WCAG20-TECHS/G200.html) 以支持 [可访问性](https://it.wisc.edu/learn/make-it-accessible/websites-and-web-applications/when-to-open-links-in-a-new-tab/) 并为读者确保一致且包容的体验。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#dian-zi-you-jian-di-zhi-mailto-lian-jie) 电子邮件地址 mailto 链接 电子邮件地址 `mailto` 当您希望访问者点击链接以打开其默认邮件客户端并填写 `要` 字段为链接的电子邮件地址，以便他们可以撰写要发送的电子邮件。 下面是插入电子邮件地址 `mailto` 链接的方法： 1. 在段落中单击您想要插入链接的位置，或选择一些文本。 2. 按 / 打开内联调色板并选择链接，点击上下文菜单中的 **链接** 按钮，或按下 **⌘ + K**. 3. 粘贴或输入 `mailto:something@address.com`，替换 `something@address.com` 为您想要使用的电子邮件地址。 4. 按下 `回车`. #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zai-markdown-zhong-de-biao-shi-2) 在 Markdown 中的表示 复制 [这是指向本空间中另一页面的相对链接](../content-structure/page.md) [这是一个绝对链接](https://www.gitbook.com/blog) [这是一个链接](mailto:support@gitbook.com) 到我们的支持邮箱地址 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#shu-xue-yu-tex) 数学与 TeX 使用此选项，您可以在内容中创建内联数学公式，如下所示： f(x)\=x∗e2piiξxf(x) = x \* e^{2 pi i \\xi x}f(x)\=x∗e2piiξx。我们使用 [KaTeX](https://katex.org/docs/supported.html) 库来渲染公式。 您还可以插入 [块级数学公式](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/math-and-tex) 方法是在线框为空的块中打开命令面板并选择第二个“数学与 TeX”选项。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zai-markdown-zhong-de-biao-shi-3) 在 Markdown 中的表示 复制 # Math and TeX block $$f(x) = x * e^{2 pi i \xi x}$$ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#an-niu) 按钮 按钮是描述号召性用语的好方法。您可以使用它们将用户发送到 GitBook 中的其他页面，或指向外部 URL。 按钮有主要样式和次要样式。以下是几个示例： [注册 GitBook](https://app.gitbook.com/join) [回到顶部](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#annotations) #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zai-markdown-zhong-de-biao-shi-4) 在 Markdown 中的表示 复制 GitBook ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#tu-biao) 图标 图标允许您为站点添加额外的视觉提示。您可以将它们内联添加到段落中、放在卡片内或放在任何需要增添装饰的地方。它们将使用在您的 [自定义设置](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/customization/icons-colors-and-themes) . 中定义的视觉样式。 [访问](https://fontawesome.com/) Font Awesome #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#zai-markdown-zhong-de-biao-shi-5) 在 Markdown 中的表示 复制 以浏览可用的不同图标。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#biao-da-shi) 表达式 表达式允许您动态显示在 [变量](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/variables-and-expressions) 中定义的内容。表达式可以从 `/` 菜单中插入。插入后，双击表达式将调出表达式编辑器，允许您引用并 [有条件地格式化](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_operator) 您的变量。 最后更新于1个月前 这有帮助吗？ --- # 表格 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以将表格添加到 GitBook 页面中，以更好地组织信息。 公司 状态 联系人 月经常性收入 (MRR) **Ace AI** – 设计 进行中 [rena@ace.ai](mailto:noreply@gitbook.com) $450 **Discrete Data** – API [dave@dd.inc](mailto:noreply@gitbook.com) $100 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#biao-ge-kuai-xuan-xiang) 表格块选项 当您打开表格块左侧的“选项”菜单时，您将看到多个用于更改外观和管理表格内数据的选项： * **表格/卡片：** 选择将数据显示为表格块或 [卡片块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards) 。GitBook 使用相同的数据填充这两种块，因此您可以根据想要的外观和设计在它们之间切换。 * **添加列：** 在表格右侧添加新列。您可以使用菜单选择列类型，或直接单击 **添加列** 以添加文本列。 * **插入行：** 在表格底部添加新行。 * **显示标题：** 隐藏或显示表格的顶行标题。根据您显示的数据，表格可能不需要标题行，因此可以在此处将其禁用。 * **重置列宽：** 如果您更改了列宽，此操作将把所有列重置为相等宽度。 * **可见列：** 选择哪些列可见，哪些列隐藏。如果表格中有隐藏列，可以在此菜单中再次使其可见。 * **全宽：** 使表格跨越窗口的整个宽度。这对于包含许多列的表格很有用。 * **删除：** 删除表格块及其所有内容。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#geng-gai-lie-lei-xing) 更改列类型 根据您要显示的数据，表格列可以设置为不同的数据类型。这些类型为列中的每个单元格添加格式、装饰或限制： * **文本：** 标准文本列，支持常规格式化。 * **数字：** 数字列，可带或不带小数位。 * **复选框：** 每行一个复选框，可被选中或取消选中。 * **选择：** 您可以从一个选项列表中选择数据，该列表可以通过打开 **列选项** 菜单并选择 **管理选项**来定义。这可以是单选或多选。 * **用户：** 您可以添加组织成员的姓名和头像。这可以是单选或多选。 * **文件：** 您可以引用空间中的文件。填充列中的单元格时可以上传新文件。 * **评分：** 星级评分。您可以通过打开 **列选项** 菜单并选择 **最大值**. 使用 **列选项** 菜单更改列的类型。当您更改列类型时，会弹出提示要求您确认更改，因为此操作可能会删除或破坏列中的数据。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#tiao-zheng-lie-da-xiao) 调整列大小 将鼠标悬停在列边缘并拖动以调整其大小。光标上方会显示像素计数，帮助您设置一致的列宽。 GitBook 将列宽存储为整体宽度的百分比，这允许根据表格的整体宽度进行相对调整。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#ke-gun-dong-biao-ge) 可滚动表格 宽度超过编辑器容器的表格将可水平滚动。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#lie-xuan-xiang) 列选项 要重新排序列，请单击并拖动列顶部的拖动手柄 ![The table drag handle icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FPnnI41SqLSaKBNwT98fW%252Factions-horizontal.svg%3Falt%3Dmedia%26token%3D99754200-a354-4ffe-931e-aa6322ea7395&width=300&dpr=4&quality=100&sign=b8b57475&sv=2) 到您要移动的位置。 您可以通过单击当将鼠标悬停在表格右边缘时出现的 **添加列** 按钮来添加新列。 在 **列选项** 菜单中，您还可以切换自动调整大小的开关，在右侧添加新列，隐藏该列或删除该列。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#xing-xuan-xiang) 行选项 将鼠标悬停在行上，然后单击出现在其左侧的 **行选项** ![The Row options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 按钮以打开 **行选项** 菜单。您将看到多个选项： * **打开行：** 在模态窗口中打开该行以显示其所有数据。在这里您可以快速更改行类型、编辑数据并查看隐藏列中的数据。 * **在上方/下方插入：** 在当前选中行的上方或下方添加新行。 * **添加列：** 在表格右侧添加新列。 * **删除行：** 永久从表格中移除该行的所有数据。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#biao-ge-zhong-de-tu-xiang) 表格中的图像 当您点击表格单元格时，可以按 / 键插入图像。此操作在标题行中无效。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/table#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 # 表格 | | | | | - | - | - | | | | | | | | | | | | | 最后更新于5个月前 这有帮助吗？ --- # 代码区块 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以使用代码块将代码添加到您的 GitBook 页面中。 当您添加代码块时，您可以选择 [设置语法](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#set-syntax...) , [显示行号](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#with-line-numbers) , [显示标题](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#with-caption) ，并且 [换行显示](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#wrap-code) 。同样也很容易 [将代码块内容复制到剪贴板](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#copying-the-code) ，以便在其他地方使用 代码块可能有用的场景包括： * 共享配置 * 添加代码片段 * 共享代码文件 * 展示命令行工具的用法示例 * 展示如何调用 API 端点 * 以及更多！ ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#dai-ma-kuai-shi-li) 代码块示例 index.js 复制 ‌import * as React from 'react'; import ReactDOM from 'react-dom'; import App from './App'; ReactDOM.render(, window.document.getElementById('root')); 您还可以将代码块与 [选项卡块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/tabs) 结合使用，以便在多种不同语言中提供相同的代码示例： JavaScript Ruby Elixir 复制 let greeting = function (name) { console.log(`Hello, ${name}!`); }; greeting("Anna"); 复制 greeting = lambda {|name| puts "Hello, #{name}!"} greeting.("Anna") 复制 greeting = fn name -> IO.puts("Hello, #{name}!") end greeting.("Anna") 您可以让代码块 [跨越窗口的全宽显示](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#full-width-blocks) 通过点击 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 在区块旁并选择 **全宽**. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#options) 代码块选项 当您点击代码块旁的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) ，或区块本身的 **操作菜单** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=f3d65ef3&sv=2) 时，您会看到可以设置的多个选项。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#set-syntax) 设置语法… 您可以将代码块的语法设置为任何受支持的语言。这也将启用该语言的语法高亮。 我们使用 [Prism](https://github.com/PrismJS/prism) 进行语法高亮。您可以使用 [试用 Prism](https://prismjs.com/test.html#language=markup) 来检查 Prism 支持哪些语言。如果您发现 GitBook 与 Prism 之间存在不匹配，可能是我们落后了一个或两个版本。我们会尽快跟上的！ filename.txt 复制 // 一些代码 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#with-line-numbers) 带行号 这将切换代码的行号显示（开/关）。 当代码表示整个文件的内容时，或当您有很长且包含许多行的代码块时，显示行号很有用。隐藏行号适用于片段、命令行或终端表达式的使用说明以及类似场景。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#dai-biao-ti) 带标题 这将切换位于区块顶部、代码行上方的标题的显示（开/关）。 标题通常是示例中所示的文件名， [如上例](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#example-of-a-code-block) ，但您也可以将其用作标题、描述或任何您想要的内容。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#huan-hang-dai-ma) 换行代码 这将切换代码换行的开/关，使长行代码在页面上一次性全部可见。 当代码较长且您希望避免读者来回滚动以阅读时，换行显示很有用。如果您打开 **换行代码** ，您也可能想显示行号——这将使代码更容易阅读并理解新行的起始位置。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#ke-zhan-kai) 可展开 这将切换以完整显示代码（当开关关闭时）或以折叠窗口显示代码（当开关打开时），用户可以展开查看完整代码。 折叠视图默认显示 10 行代码，并有一个按钮可展开以显示完整代码块。如果代码少于 10 行，则会显示所有内容。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#dai-ma-kuai-cao-zuo) 代码块操作 除了上述选项，您还可以更改代码块显示的语言，并即时复制您的代码。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#copying-the-code) 复制代码 将鼠标悬停在代码块上会显示多个图标。单击中间的图标将把代码块的内容复制到剪贴板。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 {% code title="index.js" overflow="wrap" lineNumbers="true" %} ```javascript ‌import * as React from 'react'; import ReactDOM from 'react-dom'; import App from './App'; ReactDOM.render(, window.document.getElementById('root')); ``` {% endcode %} 最后更新于5个月前 这有帮助吗？ --- # 卡片 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以使用卡片创建视觉上悦目的页面布局，在网格中组合文字和图像。它们非常适合构建登录页面或以非线性方式展示其他内容。 您可以调整 [在中等或大型卡片之间切换](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#card-size) 并将它们链接到相关资源。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#ka-pian-shi-li) 卡片示例 [](https://www.gitbook.com/) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FR8TYzdK3sBgPyHUAfLaf%252FGitBook%2520homepage.svg%3Falt%3Dmedia%26token%3D75fb66e5-2e50-47d9-8d90-91938114caf9&width=490&dpr=4&quality=100&sign=b8ab365f&sv=2) **GitBook 主页** 访问我们的网站，了解有关 GitBook 的更多信息。 [](https://developer.gitbook.com/) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FlMv6pwpKuVBb1iAgG8VE%252FDeveloper%2520docs.svg%3Falt%3Dmedia%26token%3D7c7cab48-f429-4af0-afcd-a2db9c236067&width=490&dpr=4&quality=100&sign=55ba840a&sv=2) **开发者文档** 构建您自己的 GitBook 集成！ [](https://app.gitbook.com/join) ![Cover](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FqJfxhjqa71E4ZRf2qmig%252FSignup%2520to%2520GitBook.svg%3Falt%3Dmedia%26token%3Db0fd365e-cd5b-49d9-830d-f18ee793da7c&width=490&dpr=4&quality=100&sign=ed8fcea3&sv=2) **注册 GitBook** 点击此处免费开始。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#adding-links-and-images-to-your-cards) 添加链接 将鼠标悬停在卡片上并打开其 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2)。在这里您可以添加目标链接，这样用户点击卡片时可以直接跳转到某个位置。 在创建卡片时，我们建议您使用 **目标链接而不是超链接**。使用目标链接，读者可以点击卡片上的任意位置来访问链接的 URL。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#tian-jia-tu-xiang) 添加图像 将鼠标悬停在卡片上并打开其 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2)。在这里您可以为卡片添加封面图像。或者，直接点击卡片本身的 **添加封面图像** 选项。 这将打开 **选择文件** 模态窗口。在这里您可以将新的图像拖放到此处，或使用您之前上传到空间的图像文件。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#wei-shen-se-mo-shi-tian-jia-tu-xiang) 为深色模式添加图像 您还可以添加只在深色模式下显示的封面图像。 为此，请打开卡片的 **选项菜单** ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择 **封面** > **编辑封面** > **为深色模式添加封面**。这将打开 **选择文件** 模态窗口，您可以在其中拖放新图像或选择先前上传的图像。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#xuan-ze-he-shi-de-tu-xiang-chi-cun) 选择合适的图像尺寸 GitBook 会在桌面和移动端自动将横向图像裁剪为 16:9 比例。如果您上传的图像是纵向或 1:1 比例，它们将在桌面上被裁剪为 16:9，并在移动端显示为方形或纵向。 ![A GitBook screenshot showing card images on desktop](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FNygg0LtXTalYWIWQCtOA%252F13_02_25_cards_desktop.svg%3Falt%3Dmedia%26token%3D7a485ddb-1a4a-40dd-95e8-cd03f65cbff2&width=768&dpr=4&quality=100&sign=57cd4c8b&sv=2) 在桌面端，所有卡片图像将以横向 16:9 比例显示，不论其尺寸如何。我们建议使用相同的尺寸以保持一致性。 ![A GitBook screenshot showing card images on mobile](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Ft16RVp4AO8Ms8Qll6j1N%252F13_02_25_cards_mobile.svg%3Falt%3Dmedia%26token%3D5b34cf07-dbee-4f19-ab2d-d0126f502ecf&width=768&dpr=4&quality=100&sign=2f845b6e&sv=2) 在移动端，方形或纵向图像将如左侧所示显示。横向图像将如右侧所示显示。 为了在桌面和移动端保持一致，我们建议将所有卡片图像以 16:9 格式上传（例如 1920px x 1080px）。 如果您希望卡片根据屏幕尺寸自适应布局，我们建议上传 1:1 比例的图像，并将图像内容居中。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#geng-gai-ka-pian-da-xiao) 更改卡片大小 您可以通过打开位于卡片区块左侧的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 来选择卡片大小。该 **中等** 选项在一行中创建三个卡片，而 **大型** 选项在每行显示两个更大的卡片。 您可以使卡片区块 [占满窗口的全部宽度](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#full-width-blocks) 方法是点击区块旁边的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=40&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择 **全宽**. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制
示例标题 1 示例描述 1。 https://example.com example_image1.svg
示例标题 2 示例描述 2。 https://example.com example_image2.svg
示例标题 3 示例描述 3。 https://example.com example_image3.svg
最后更新于2个月前 这有帮助吗？ --- # 变量与表达式 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 使用变量可以创建可重用的文本，该文本可以在 [表达式](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#expressions) 并且 [自适应内容的条件中被有条件地引用](https://gitbook.com/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/adapting-your-content#working-with-the-condition-editor) . 如果您在内容中多次重复相同的名称、短语或版本号，您可以创建一个 **表达式允许您动态显示在一个** 以帮助保持所有这些实例的同步和准确——如果您需要更新它们，或它们复杂且经常拼写错误，这将非常有用。 您可以创建作用域为单个页面或单个空间的变量。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/variables-and-expressions#chuang-jian-xin-bian-liang) 创建新变量 要创建新变量，请点击 **变量** ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FLm9dLFUy5c3i4YOEwvSz%252Fvariables.svg%3Falt%3Dmedia%26token%3Dae18f815-541c-4b17-ae42-9c4d90897899&width=300&dpr=4&quality=100&sign=2866b9e1&sv=2) 在编辑已打开的 [变更请求](https://gitbook.com/docs/documentation/zh/xie-zuo/change-requests) 的右上角的图标。 这将打开变量侧边栏。 您可以使用顶部的切换来查看并创建作用域为当前页面或当前空间内所有页面的变量。 点击 **创建变量** 将打开一个模式对话框，您可以在其中为变量命名并设置其值。 点击 **添加变量** 以保存您的变量。 ![A GitBook screenshot showing the Add variables screen. The variable Name box has been filled with the text ‘latest_version’ and the Value box has been filled with the text ‘v3.04.1’](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FmyWu2r6UfxkMRCjcDZuc%252Fvariables.jpg%3Falt%3Dmedia%26token%3D40408b2f-bdb2-41bd-9763-bc8caf3bfd40&width=768&dpr=4&quality=100&sign=4ae47053&sv=2) 您可以将变量添加到单个页面或整个空间。 当您更新变量的值时，其每个实例都会更新。 变量名必须以字母开头，并且可以包含字母、数字和下划线。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/variables-and-expressions#zai-nei-rong-zhong-shi-yong-bian-liang) 在内容中使用变量 变量可以在一个 [表达式](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline#expressions) 中被引用并使用——您可以将其内联插入到内容中。 插入表达式后，双击它以打开表达式编辑器。 在您页面下定义的变量可在 `page.vars` 对象下访问。 类似地，在整个空间中定义的变量可在 `space.vars` 对象来定义。 ![A GitBook screenshot showing an expression block within the editor. The expression editor is open below it and the ‘space.vars.latest_version’ variable has been selected](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FAYoxSMGR9BAtkV9aBszX%252Finsert-variables-expression.jpg%3Falt%3Dmedia%26token%3Dece25501-bfa2-4da8-82c1-f4e4f7ba3f89&width=768&dpr=4&quality=100&sign=8453888a&sv=2) 下访问。您可以在表达式中向内容添加变量。表达式编辑器提供自动完成选项，帮助您找到所需的变量。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/variables-and-expressions#geng-xin-bian-liang) 更新变量 在变更请求期间的任何时候，您都可以更新变量。更新其值将更新引用该变量的任何表达式块中的值。一旦变更请求合并，已更改的变量将在任何已发布的网站上生效。 最后更新于4个月前 这有帮助吗？ --- # 列 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 列是一种创建不同文档布局的好方法。您可以在列中添加许多不同类型的区块，并调整每一侧的宽度以根据所需设计进行自定义。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/columns#zai-wen-dang-yu-chan-pin-zhi-jian-chuang-jian-wu-feng-ti-yan) 在文档与产品之间创建无缝体验 将文档直接集成到产品体验中，或为用户提供个性化体验，让他们更快获得所需内容。 [了解更多](https://www.gitbook.com/#alpha-waitlist) ![An image of GitBook icons demonstrating side by side column functionality](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F7gRpMBKOqTx3tvgNZJlH%252Fgitbook%2520vision%2520post.png%3Falt%3Dmedia%26token%3D1f0d2409-4cc7-423a-8c94-9fd7475ab762&width=768&dpr=4&quality=100&sign=faff1c8d&sv=2) [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/columns#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 ------------------------------------------------------------------------------------------------------------------------------------- 复制 ## 示例 {% columns %} {% column width="50%" %} ### 在文档与产品之间创建无缝体验 将文档直接集成到产品体验中，或为用户提供个性化体验，让他们更快获得所需内容。 了解更多 {% endcolumn %} {% column %}
展示并排列功能的 GitBook 图标图片
{% endcolumn %} {% endcolumns %} 最后更新于3个月前 这有帮助吗？ --- # 图片 | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook 助手 思考中... GitBook Assistant ##### 晚安 我在这里帮助您了解文档。 这个页面讲的是什么？我接下来应该读什么？您能举个例子吗？ Ctrli AI 基于您的上下文 发送 您可以将图像插入页面，然后选择其大小以及将其对齐到左侧、居中或右侧。您还可以选择在图像块上添加替代文本和/或说明。 **提示：** 出于可访问性考虑，我们建议为图像设置替代文本（alt 文本）。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#example-of-an-image-block) 图像块示例 ![A photograph taken from space looking back towards Earth. A satellite is in the foreground, and in the background is an ocean-covered part of our planet with patchy clouds.](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2Fimages.unsplash.com%2Fphoto-1446776709462-d6b525c57bd3%3Fcrop%3Dentropy%26cs%3Dsrgb%26fm%3Djpg%26ixid%3DM3wxOTcwMjR8MHwxfHNlYXJjaHwyfHxzcGFjZXxlbnwwfHx8fDE3MzMxOTY5NTR8MA%26ixlib%3Drb-4.0.3%26q%3D85&width=768&dpr=4&quality=100&sign=5ab0271&sv=2) 带有说明的图像块示例 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#shang-chuan-tu-xiang) 上传图像 有两种方法可以将图像添加到内容中： 1. 将图像从您的文件管理系统拖放到页面上的空白块中。 2. [向您的页面添加图像块](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#inserting-a-new-content-block) 并使用 **选择图像** 出现在窗口右侧的侧边面板。 如果您按照第二种流程，您可以选择上传文件、选择先前上传的文件、粘贴图像 URL 或从 [Unsplash](https://unsplash.com/) 使用内置搜索添加图像。 GitBook 允许您上传每个文件大小最多为 100MB 的图像。 #### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#chuang-jian-tu-xiang-ku) 创建图像库 向图像块添加多个图像将创建一个图库。为此，请打开该块的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择 **添加图像…** 以再次打开 **选择图像** 侧边面板。 要从图库中删除图像，请打开要删除的图像上的 **编辑菜单** ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FA3OfGjPkE5GnOQvN36jN%252Fedit.svg%3Falt%3Dmedia%26token%3D6f70239f-d889-4e64-9ec6-4801df47a48d&width=300&dpr=4&quality=100&sign=d2777f3e&sv=2) 并按下 **删除 ⌫** 键。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#light-and-dark-mode) 为亮/暗模式添加图像 您可以为已发布站点的亮模式和暗模式设置不同的图像。GitBook 会根据访问者所处的模式自动显示正确的图像。 要为暗模式添加图像，请将鼠标悬停在图像上，打开 **编辑菜单** ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FA3OfGjPkE5GnOQvN36jN%252Fedit.svg%3Falt%3Dmedia%26token%3D6f70239f-d889-4e64-9ec6-4801df47a48d&width=300&dpr=4&quality=100&sign=d2777f3e&sv=2) 然后点击 **替换图像** ![The Replace image icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F0mPo1tPDFeEbPOr1gc4V%252Freplace%2520image.svg%3Falt%3Dmedia%26token%3D9f037f9a-0f37-4c5b-9b30-6b55ffb11f5b&width=300&dpr=4&quality=100&sign=e9d28da9&sv=2). 在下拉菜单中，选择 **为暗模式添加图像**。设置后，您可以从同一菜单替换任一图像。 **注意：** GitBook 目前不支持某些情况下的亮/暗模式图像，包括页面封面或卡片上的图像封面 [卡片](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#light-and-dark-mode-through-github-gitlab-sync) 通过 GitHub/GitLab 同步的亮/暗模式图像 您也可以通过 HTML 语法（`` 和 ``). 在 Markdown 中添加亮/暗模式图像。 `对于块级图像，使用`
`` 和 `` HTML 元素并在其中包含一个 复制 ： 对于块级图像，使用 图像之前的文本 media="(prefers-color-scheme: dark)" alt="GitHub logo"
说明文本
图像之后的文本 ``
`` HTML 元素并在其中包含一个 复制 对于内联图像（与文本在同一行的图像），使用 图像之前的文本 alt="The GitHub Logo" /> **注意：** 以及图像之后的文本 [我们尚不支持](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) 仅限 GitHub 的语法 `通过` #gh-dark-mode-only `或`. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#gh-light-mode-only) #gh-light-mode-only 调整大小 **编辑菜单** ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FA3OfGjPkE5GnOQvN36jN%252Fedit.svg%3Falt%3Dmedia%26token%3D6f70239f-d889-4e64-9ec6-4801df47a48d&width=300&dpr=4&quality=100&sign=d2777f3e&sv=2)要调整图像大小，请将鼠标悬停在图像上并打开 **。点击** 大小 ![A GitBook screenshot showing how to resize an image](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fgit-blob-85f7b1f17894a13cae478727fdb8ffd1b37950e1%252F10_01_25_image_resizing.svg%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=1424fabc&sv=2) 按钮以从可用选项更改图像的大小。 * **调整图像大小** 小 * **– 图像大小的 25%** 中等 * **– 图像大小的 50%** 大 * **– 图像大小的 75%** 适应 **735** **– 删除所有大小规格并以原始大小显示，或对于较大图像限制为最大宽度** 像素 如果您的图像比编辑器更宽，GitBook 会将图像的宽度限制为编辑器的宽度，并且调整大小将基于该限制。 **注意：** 在图像库中调整图像大小时，结果可能与调整单个图像的大小不同。 您可以将图像块 [使其跨越窗口的全宽](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks#full-width-blocks) 通过点击位于块旁的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择 **全宽**. ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#tong-guo-git-tong-bu-diao-zheng-tu-xiang-da-xiao) 通过 Git 同步调整图像大小 如果您想更精确地控制图像的大小，您可以在 GitHub 或 GitLab 中使用 Markdown 指定确切尺寸。 当我们导出图像时，我们使用 HTML 标签 ``。根据规范，我们可以使用 `width` 和 `height` 属性来指定图像的尺寸，这些属性仅接受以像素为单位的值或数字与 `%` 符号的组合。 指定图像尺寸的有效变体包括： `` 将图像设置为宽度 100 像素 `` 将图像设置为全宽（尽管这将受编辑器限制） ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#dui-qi-tu-xiang) 对齐图像 默认情况下，图像块将以原始大小居中显示图像。 要更改图像的对齐方式，请打开该块的 **选项菜单** ![The Options menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并选择所需的对齐方式。此操作仅影响比编辑器窄的图像，或您已 [调整大小的图像](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#resizing) . ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#wei-tu-xiang-jia-bian-kuang) 为图像加边框 您可以为图像块添加边框，使图像具有一致的外观，并在视觉上将其与周围内容分隔开。 ![A black and white photograph of a lone figure walking across a stark white landscape](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FfL0VWcltHyuCKeqJsW0Q%252Fimage-frame-demo%25402x.jpg%3Falt%3Dmedia%26token%3D6cac6c68-c288-4c42-abb2-e2bb7de23652&width=768&dpr=4&quality=100&sign=dc84e76c&sv=2) 带框的图像可以有说明，并在说明后显示细微的网格背景。 要为图像添加边框，请将鼠标悬停在图像上，打开该块的 **选项菜单** ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F2111890564-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FaS1QvPIBVYwhpFTGcPBN%252Foptions-menu.svg%3Falt%3Dmedia%26token%3D3ee40bbf-f4fb-41fa-aa30-306b559cbe88&width=300&dpr=4&quality=100&sign=b76a8b99&sv=2) 并启用 **带框** 切换开关。 **注意事项：** 您只能为块中的单张图像添加边框。包含多张图像的图像块和内联图像无法添加边框。 ### [](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images#zai-markdown-zhong-de-biao-shi) 在 Markdown 中的表示 复制 //简单块 ![](https://gitbook.com/images/gitbook.png) //带说明的块 ![The GitBook Logo](https://gitbook.com/images/gitbook.png) //带替代文本的块
The GitBook Logo
//带说明和替代文本的块
The GitBook Logo

GitBook Logo

// 带框图像的块
The GitBook Logo
//在亮暗模式下使用不同图像并带说明的块 对于块级图像，使用 GitHub logo alt="GitHub logo"
说明文本
最后更新于1个月前 这有帮助吗？ --- # Unknown \# LLM-ready docs We’re building features that make it easier for Large Language Models (LLMs) to ingest and work with your documentation content. As LLMs become increasingly important for information retrieval and knowledge assistance, ensuring your documentation is LLM-friendly can significantly improve how these models understand and represent your products or services. LLM-optimized documentation ensures that AI systems like ChatGPT, Claude, Cursor, and Copilot can retrieve and provide accurate, contextual responses about your product or API. ## .md pages With GitBook, all of the pages of your docs site are automatically available as markdown files. If you add the \`.md\` extension to any page, you will see the content of that page rendered in markdown which you can pass to an LLM for more efficient processing than an HTML file. [Check out the .md file for this page](https://gitbook.com/docs/publishing-documentation/llm-ready-docs.md) ## llms.txt \[llms.txt\](https://llmstxt.org/) is a proposed standard for making web content available in text-based formats that are easier for LLMs to process. You can access the \`llms.txt\` page by appending \`/llms.txt\` to the root URL of your docs site. The \`llms.txt\` file serves as an index for your documentation site, providing a comprehensive list of all available markdown-formatted pages. With this file, you make it easier for LLMs to efficiently discover and process your documentation content. [Check out the /llms.txt for the GitBook docs](https://gitbook.com/docs/llms.txt) ## llms-full.txt Where the \`llms.txt\` file contains an index of all the page URLs and titles of of your documentation site, the \`llms-full.txt\` contains the full content of your documentation site in one file that can be passed to LLMs as context. [Check out the /llms-full.txt file for the GitBook docs](https://gitbook.com/docs/llms-full.txt) LLMs can use this index to navigate directly to the markdown versions of your pages, allowing them to incorporate your documentation into their context without needing to parse HTML. ## MCP server GitBook automatically exposes a Model Context Protocol (MCP) server for every published space. MCP gives AI tools a structured way to discover and retrieve your docs as resources — no scraping required. Your MCP server can be reached by appending \`/~gitbook/mcp\` to the URL of the root of your docs site. For instance, the GitBook docs MCP server is located at \`https://gitbook.com/docs/~gitbook/mcp\`. {% hint style="info" %} Visiting this URL in your browser will result in an error. Instead, you can share this with tools that can make HTTP requests, like LLMs or IDEs. {% endhint %} Learn more by reading \[mcp-servers-for-published-docs\](https://gitbook.com/docs/publishing-documentation/mcp-servers-for-published-docs "mention"). ## Tips for optimizing your docs for LLMs Now that your GitBook site automatically generates \`.md\` pages, \`llms.txt\`, and \`llms-full.txt\` files, these best practices will help LLMs effectively understand and work with your content. By using these optimizations, you may also improve your documentation’s performance in AI-powered search engines and generative engine optimization (GEO). The best part? These guidelines will generally make your docs easier for people to read as well. ### Use clear, hierarchical structure Break up your content with good headings (H1, H2, H3) and don’t just write giant walls of text. Bullet points, numbered lists and shorter paragraphs make everything easier to read. ### Write concise, jargon-free content Keep it simple and skip complex technical terms unless you really need them. LLMs do much better when you say what you mean without adding fluff. ### Include practical examples Show, don’t just tell. Code snippets, API examples, and real scenarios help LLMs — and your users — understand how things actually work in practice. ### Keep content current and accurate Nobody likes outdated docs. Regular updates mean LLMs won’t give people wrong information about your latest features and updates. ### Test with AI tools Actually try asking ChatGPT or Claude questions about your docs to see how well they understand your content. You might be surprised by what works and what doesn’t. --- # Unknown \# GitBook Documentation ## Documentation - \[GitBook documentation\](/docs/getting-started/readme.md): Create and publish beautiful documentation your users will love. GitBook has all the docs tools you need to create everything from product guides to API references and beyond. - \[Quickstart\](/docs/getting-started/quickstart.md): Get up and running in GitBook and publish your first docs site in minutes - \[Concepts\](/docs/getting-started/concepts.md): Learn the basics of so you can create and publish outstanding documentation for your users - \[Migrate to GitBook\](/docs/getting-started/import.md): How to import existing content into GitBook from Confluence, Notion, Git and more - \[AI-native features\](/docs/getting-started/ai-documentation.md): Learn how AI documentation helps your users find answers, your team maintain docs efficiently, and your docs be more discoverable by AI tools like ChatGPT - \[GitHub & GitLab Sync\](/docs/getting-started/git-sync.md): Synchronize your GitBook content with GitHub or GitLab with GitBook’s bi-directional integration - \[Enabling GitHub Sync\](/docs/getting-started/git-sync/enabling-github-sync.md): Set up and authorize the GitHub integration for GitBook - \[Enabling GitLab Sync\](/docs/getting-started/git-sync/enabling-gitlab-sync.md): Set up and authorize the GitLab integration for GitBook - \[Content configuration\](/docs/getting-started/git-sync/content-configuration.md): Configure Git Sync with extra functionalities - \[GitHub pull request preview\](/docs/getting-started/git-sync/github-pull-request-preview.md): See a preview of your content when making a pull request in GitHub - \[Commit messages & Autolink\](/docs/getting-started/git-sync/commits.md) - \[Monorepos\](/docs/getting-started/git-sync/monorepos.md) - \[Troubleshooting\](/docs/getting-started/git-sync/troubleshooting.md) - \[Formatting your content\](/docs/creating-content/formatting.md): Format your content in various ways using the context menu or keyboard shortcuts - \[Inline content\](/docs/creating-content/formatting/inline.md): Use the inline palette to add images, links, math & TeX, and more - \[Markdown\](/docs/creating-content/formatting/markdown.md): Write Markdown directly in the editor to easily create content using common syntax - \[Content structure\](/docs/creating-content/content-structure.md): Create pages, spaces and collections - \[Spaces\](/docs/creating-content/content-structure/space.md): Organize the content you create and publish into spaces - \[Pages\](/docs/creating-content/content-structure/page.md): Add pages, page groups or external links — and learn about the options you have on each page - \[Collections\](/docs/creating-content/content-structure/collection.md): Organize your spaces into folders - \[Blocks\](/docs/creating-content/blocks.md): Add and edit blocks within your content - \[Paragraphs\](/docs/creating-content/blocks/paragraph.md): Add a paragraph block to insert formatted text, inline images and more - \[Headings\](/docs/creating-content/blocks/heading.md): Add heading blocks to a page to organize your content and improve SEO - \[Unordered lists\](/docs/creating-content/blocks/unordered-list.md): Add an unordered list block to create bullet point lists - \[Ordered lists\](/docs/creating-content/blocks/ordered-list.md): Add an ordered or numbered list to a page - \[Task lists\](/docs/creating-content/blocks/task-list.md): Add a task list to display tasks that can be completed - \[Hints\](/docs/creating-content/blocks/hint.md): Add a hint to a page to draw your reader’s attention to specific pieces of important information. - \[Quotes\](/docs/creating-content/blocks/quote.md): Add a quote block to a page to highlight copy you’re adding from elsewhere, or to draw attention to a specific part of your text - \[Code blocks\](/docs/creating-content/blocks/code-block.md): Add a code block to a page to include sample code, configurations, code snippets and more - \[Files\](/docs/creating-content/blocks/insert-files.md): Manage and add files to your space such as PDFs, videos, documents and more - \[Images\](/docs/creating-content/blocks/insert-images.md): Add an image or a gallery of images to a page, add image variants for dark mode, and resize and align images to your needs - \[Embedded URLs\](/docs/creating-content/blocks/embed-a-url.md): Embed videos, music and more directly into your page with a URL - \[Tables\](/docs/creating-content/blocks/table.md): Keep information organized and make documenting data easier with tables - \[Cards\](/docs/creating-content/blocks/cards.md): Display information more dynamically with a set of cards — with or without images - \[Tabs\](/docs/creating-content/blocks/tabs.md): Add tabs so you can display large blocks of related information without creating a long, hard-to-navigate page - \[Expandable\](/docs/creating-content/blocks/expandable.md): Add an expandable block to a page to keep your pages shorter, hide longer content, or create FAQs - \[Stepper\](/docs/creating-content/blocks/stepper.md): Add a step-by-step guide to a page — perfect for guides, walkthroughs and technical troubleshooting processes - \[Drawings\](/docs/creating-content/blocks/drawing.md): Create drawings within GitBook and add them to your page - \[Math & TeX\](/docs/creating-content/blocks/math-and-tex.md): Add a mathTeX block to a page when you want to display a mathematical formula in your documentation - \[Page links\](/docs/creating-content/blocks/page-link.md): Add a page link block to show relations between pages in your space. - \[Columns\](/docs/creating-content/blocks/columns.md): Add a column to create different layouts in your documentation. - \[Conditional content\](/docs/creating-content/blocks/conditional-content.md) - \[Variables and expressions\](/docs/creating-content/variables-and-expressions.md): Create reusable variables that can be referenced in pages and spaces - \[Reusable content\](/docs/creating-content/reusable-content.md): Create reusable blocks of content that can be used across spaces, and all updated at once when you change an instance - \[Searching internal content\](/docs/creating-content/searching-your-content.md): Find what you’re looking for faster with keyword search and AI-powered smart search - \[Search & Quick find\](/docs/creating-content/searching-your-content/quick-find.md): Search and navigate your documentation fast with quick find - \[GitBook AI\](/docs/creating-content/searching-your-content/gitbook-ai.md): GitBook uses AI to help you find the knowledge you need within your organization, faster - \[Writing with GitBook AI\](/docs/creating-content/write-and-edit-with-ai.md): Use GitBook AI to generate and build content for your page - \[Version control\](/docs/creating-content/version-control.md): Keep track of changes, roll back to a previous version and more - \[Translations\](/docs/creating-content/translations.md): Auto-translate your content into multiple languages using AI and keep it synced - \[OpenAPI\](/docs/api-references/openapi.md): Add an OpenAPI spec to a page and let your users test endpoints right on the page with interactive blocks. - \[Add an OpenAPI specification\](/docs/api-references/openapi/add-an-openapi-specification.md): Learn how to add and update an OpenAPI specification in GitBook application or from CLI - \[Insert API reference in your docs\](/docs/api-references/openapi/insert-api-reference-in-your-docs.md): Insert complete API reference from your OpenAPI spec or pick individual operation or schemas - \[Guides\](/docs/api-references/guides.md) - \[Structuring your API reference\](/docs/api-references/guides/structuring-your-api-reference.md): Learn how to structure your API reference across multiple pages with icons and descriptions - \[Adding custom code samples\](/docs/api-references/guides/adding-custom-code-samples.md): Learn how to configure custom code samples to display alongside your API endpoints - \[Managing API operations\](/docs/api-references/guides/managing-api-operations.md): Learn how to mark an OpenAPI API operation as experimental, deprecated or hide it from your documentation - \[Configuring the “Test it” button\](/docs/api-references/guides/configuring-the-test-it-button.md) - \[Describing enums\](/docs/api-references/guides/describing-enums.md): Learn how to add descriptions to enums - \[Integrating with CI/CD\](/docs/api-references/guides/support-for-ci-cd-with-api-blocks.md): Learn how to automate the update of your OpenAPI specification in GitBook - \[Extensions reference\](/docs/api-references/extensions-reference.md): The complete reference of OpenAPI extensions supported by GitBook - \[Publish a docs site\](/docs/publishing-documentation/publish-a-docs-site.md): Publish your documentation to the internet as a docs site - \[Public publishing\](/docs/publishing-documentation/publish-a-docs-site/public-publishing.md): Publish your docs publicly to the web so that everyone can access them - \[Private publishing with share links\](/docs/publishing-documentation/publish-a-docs-site/share-links.md): Add greater control over who can view your published GitBook documentation - \[Site structure\](/docs/publishing-documentation/site-structure.md): Add structure to your published documentation using site sections and variants - \[Site sections\](/docs/publishing-documentation/site-structure/site-sections.md): Add multiple products to your site as site sections and create a content hub with tabs to access all your content - \[Content variants\](/docs/publishing-documentation/site-structure/variants.md): Publish documentation for multiple product versions or languages in a single site - \[Site customization\](/docs/publishing-documentation/customization.md): Create branded documentation with a custom logo, fonts, colors, links and more - \[Icons, colors, and themes\](/docs/publishing-documentation/customization/icons-colors-and-themes.md): Customize icons, colors, themes and more - \[Layout and structure\](/docs/publishing-documentation/customization/layout-and-structure.md): Customize the layout and structure of your published documentation - \[Extra configuration\](/docs/publishing-documentation/customization/extra-configuration.md): Configure extra options for your published documentation - \[Set a custom domain\](/docs/publishing-documentation/custom-domain.md): Set a custom domain for your docs sites - \[Setting a custom subdirectory\](/docs/publishing-documentation/setting-a-custom-subdirectory.md): Set a custom subdirectory for your docs sites - \[Configuring a subdirectory with Cloudflare\](/docs/publishing-documentation/setting-a-custom-subdirectory/configuring-a-subdirectory-with-cloudflare.md): Host your documentation with a /docs subdirectory using Cloudflare - \[Configuring a subdirectory with Vercel\](/docs/publishing-documentation/setting-a-custom-subdirectory/configuring-a-subdirectory-with-vercel.md): Host your documentation with a /docs subdirectory using Vercel - \[Configuring a subdirectory with AWS using CloudFront and Route 53\](/docs/publishing-documentation/setting-a-custom-subdirectory/configuring-a-subdirectory-with-aws.md): Host your documentation with a /docs subdirectory using AWS CloudFront and Route 53. - \[Site settings\](/docs/publishing-documentation/site-settings.md): Customize and edit settings across your published site - \[Site insights\](/docs/publishing-documentation/insights.md): View analytics and insights related to your published documentation’s traffic - \[Site redirects\](/docs/publishing-documentation/site-redirects.md): Set up site redirects to route traffic to content anywhere on your site - \[Authenticated access\](/docs/publishing-documentation/authenticated-access.md): Set up custom authentication for your published content - \[Enabling authenticated access\](/docs/publishing-documentation/authenticated-access/enabling-authenticated-access.md) - \[Setting up Auth0\](/docs/publishing-documentation/authenticated-access/setting-up-auth0.md): Set up an Auth0 login screen for visitors to your docs - \[Setting up Azure AD\](/docs/publishing-documentation/authenticated-access/setting-up-azure-ad.md): Set up an Azure AD login screen for visitors to your docs - \[Setting up AWS Cognito\](/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito.md): Set up an AWS Cognito login screen for visitors to your docs - \[Setting up Okta\](/docs/publishing-documentation/authenticated-access/setting-up-okta.md): Set up an Okta login screen for visitors to your docs - \[Setting up OIDC\](/docs/publishing-documentation/authenticated-access/setting-up-oidc.md): Set up an OIDC login screen for visitors to your docs - \[Setting up a custom backend\](/docs/publishing-documentation/authenticated-access/setting-up-a-custom-backend.md): Set up a custom login screen for visitors to your docs - \[Adaptive content\](/docs/publishing-documentation/adaptive-content.md): Deliver a tailored documentation experience based on who's reading - \[Enabling adaptive content\](/docs/publishing-documentation/adaptive-content/enabling-adaptive-content.md): Choose an authentication method to pass user data to GitBook - \[Cookies\](/docs/publishing-documentation/adaptive-content/enabling-adaptive-content/cookies.md): Pass visitor data into your docs through a public or signed cookie - \[URL\](/docs/publishing-documentation/adaptive-content/enabling-adaptive-content/url.md): Pass visitor data into your docs through URL query parameters - \[Feature flags\](/docs/publishing-documentation/adaptive-content/enabling-adaptive-content/feature-flags.md): Pass visitor data into your docs through a feature flag provider - \[Authenticated access\](/docs/publishing-documentation/adaptive-content/enabling-adaptive-content/authenticated-access.md) - \[Adapting your content\](/docs/publishing-documentation/adaptive-content/adapting-your-content.md): Tailor your content for different users - \[Testing with segments\](/docs/publishing-documentation/adaptive-content/testing-with-segments.md): Test your conditions with mock data - \[AI Search\](/docs/publishing-documentation/ai-search.md): Help your users find the information they need faster with powerful AI search tools for your published content - \[GitBook Assistant\](/docs/publishing-documentation/gitbook-ai-assistant.md): GitBook Assistant offers users answers based on your docs and tailored to their situation — not just generic responses - \[Embedding\](/docs/publishing-documentation/gitbook-ai-assistant/embedding.md): Choose the embedding method that best fits your tech stack and integration requirements - \[Script tag\](/docs/publishing-documentation/gitbook-ai-assistant/embedding/script.md): Add GitBook Assistant to any website with a simple script tag - \[Node.js/NPM\](/docs/publishing-documentation/gitbook-ai-assistant/embedding/nodejs.md): Integrate GitBook Assistant using the NPM package for full application-level control - \[React\](/docs/publishing-documentation/gitbook-ai-assistant/embedding/react.md): Use prebuilt React components to embed GitBook Assistant in your React application - \[Authentication\](/docs/publishing-documentation/gitbook-ai-assistant/using-with-authenticated-docs.md): Embed GitBook Assistant on sites that require authentication by dynamically loading the script after users sign in - \[Configuration\](/docs/publishing-documentation/gitbook-ai-assistant/configuration.md) - \[Customizing the Assistant\](/docs/publishing-documentation/gitbook-ai-assistant/configuration/customizing-gitbook-assistant.md): Customize the experience when embedding GitBook Assistant into your product or app by setting welcome messages, buttons, and more - \[Creating custom tools\](/docs/publishing-documentation/gitbook-ai-assistant/configuration/creating-custom-tools.md): Add custom tools to GitBook Assistant to allow it to interact with your product, website, and more - \[Reference\](/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference.md): Learn more about the methods available to use when working with GitBook Assistant programmatically - \[LLM-ready docs\](/docs/publishing-documentation/llm-ready-docs.md): Providing an LLM-friendly version of your docs site - \[MCP servers for published docs\](/docs/publishing-documentation/mcp-servers-for-published-docs.md): Docs published on GitBook automatically generate an MCP server you can hook up to external tools - \[Live edits\](/docs/collaboration/live-edits.md): Edit pages in real-time with other collaborators - \[Change requests\](/docs/collaboration/change-requests.md): Collaborate on content edits through change requests - \[PDF export\](/docs/collaboration/pdf-export.md): Export a PDF copy of your GitBook content - \[Inviting your team\](/docs/collaboration/share.md): Collaborate with your teammates on spaces, collections and more - \[Merge rules\](/docs/collaboration/merge-rules.md): Define requirements that must be met before change requests can be merged - \[Comments\](/docs/collaboration/comments.md): Ask questions to your team or receive feedback on the content you create - \[Notifications\](/docs/collaboration/notifications.md): Receive notifications about new content, updates to your spaces or changes in visibility - \[Install and manage integrations\](/docs/integrations/install-an-integration.md): Install an integration in a single space, or all the spaces in your organization - \[Plans\](/docs/account-management/plans.md): Learn about the differences in plans GitBook has - \[Community plan\](/docs/account-management/plans/community.md): Apply for our Open Source plan in GitBook - \[Sponsored site plan\](/docs/account-management/plans/community/sponsored-site-plan.md): Learn more about how you can earn money from your documentation site with our sponsored site plan - \[Billing policy\](/docs/account-management/plans/billing-policy.md) - \[Subscription cancellations\](/docs/account-management/cancelling-a-plan.md): Cancel your subscription - \[Personal settings\](/docs/account-management/account-settings.md): View and manage the settings for your personal GitBook account - \[Organization settings\](/docs/account-management/organization-settings.md): Learn how to manage your organization in GitBook - \[Member management\](/docs/account-management/member-management.md): Learn how to manage access to content for members of your organization - \[Invite or remove members\](/docs/account-management/member-management/invite-members-to-your-organization.md) - \[Roles\](/docs/account-management/member-management/roles.md) - \[Teams\](/docs/account-management/member-management/teams.md): Teams are a great way of grouping members within your organization - \[Permissions and inheritance\](/docs/account-management/member-management/permissions-and-inheritance.md) - \[SSO & SAML\](/docs/account-management/sso-and-saml.md): Learn how to share your GitBook content via SSO & SAML - \[SSO Members vs non-SSO\](/docs/account-management/sso-and-saml/sso-members-vs-non-sso.md) - \[GitBook UI\](/docs/resources/gitbook-ui.md): Learn about the different components and UI in GitBook’s editor - \[Toolbar on published sites and site previews\](/docs/resources/gitbook-ui/toolbar-on-published-sites-and-site-previews.md) - \[Keyboard shortcuts\](/docs/resources/keyboard-shortcuts.md): A quick reference guide to all the keyboard shortcuts available in GitBook - \[Glossary\](/docs/resources/glossary.md) \* \[Documentation GitBook\](/docs/documentation/fr/prise-en-main/readme.md): Créez et publiez une documentation magnifique que vos utilisateurs vont adorer. GitBook dispose de tous les outils de documentation dont vous avez besoin pour créer tout, des guides produits aux références API et au-delà. \* \[Démarrage rapide\](/docs/documentation/fr/prise-en-main/quickstart.md): Prenez en main GitBook et publiez votre premier site de documentation en quelques minutes \* \[Concepts\](/docs/documentation/fr/prise-en-main/concepts.md): Apprenez les bases pour pouvoir créer et publier une documentation exceptionnelle pour vos utilisateurs \* \[Migrer vers GitBook\](/docs/documentation/fr/prise-en-main/import.md): Comment importer du contenu existant dans GitBook depuis Confluence, Notion, Git et plus \* \[Fonctionnalités natives IA\](/docs/documentation/fr/prise-en-main/ai-documentation.md): Découvrez comment la documentation pilotée par l'IA aide vos utilisateurs à trouver des réponses, votre équipe à maintenir efficacement la documentation, et rend vos docs plus détectables par des outils d'IA comme ChatGPT \* \[Synchronisation GitHub & GitLab\](/docs/documentation/fr/prise-en-main/git-sync.md): Synchronisez votre contenu GitBook avec GitHub ou GitLab grâce à l'intégration bidirectionnelle de GitBook \* \[Activation de la synchronisation GitHub\](/docs/documentation/fr/prise-en-main/git-sync/enabling-github-sync.md): Configurez et autorisez l'intégration GitHub pour GitBook \* \[Activation de la synchronisation GitLab\](/docs/documentation/fr/prise-en-main/git-sync/enabling-gitlab-sync.md): Configurez et autorisez l'intégration GitLab pour GitBook \* \[Configuration du contenu\](/docs/documentation/fr/prise-en-main/git-sync/content-configuration.md): Configurez la synchronisation Git avec des fonctionnalités supplémentaires \* \[Aperçu des pull requests GitHub\](/docs/documentation/fr/prise-en-main/git-sync/github-pull-request-preview.md): Voir un aperçu de votre contenu lors d'une pull request sur GitHub \* \[Messages de commit & Autolink\](/docs/documentation/fr/prise-en-main/git-sync/commits.md) \* \[Monoréférentiels\](/docs/documentation/fr/prise-en-main/git-sync/monorepos.md) \* \[Dépannage\](/docs/documentation/fr/prise-en-main/git-sync/troubleshooting.md) \* \[Mise en forme de votre contenu\](/docs/documentation/fr/creation-de-contenu/formatting.md): Formatez votre contenu de différentes façons en utilisant le menu contextuel ou des raccourcis clavier \* \[Contenu en ligne\](/docs/documentation/fr/creation-de-contenu/formatting/inline.md): Utilisez la palette en ligne pour ajouter des images, des liens, des mathématiques & TeX, et plus \* \[Markdown\](/docs/documentation/fr/creation-de-contenu/formatting/markdown.md): Écrivez du Markdown directement dans l'éditeur pour créer facilement du contenu en utilisant une syntaxe courante \* \[Structure du contenu\](/docs/documentation/fr/creation-de-contenu/content-structure.md): Créer des pages, des espaces et des collections \* \[Espaces\](/docs/documentation/fr/creation-de-contenu/content-structure/space.md): Organisez le contenu que vous créez et publiez en espaces \* \[Pages\](/docs/documentation/fr/creation-de-contenu/content-structure/page.md): Ajoutez des pages, des groupes de pages ou des liens externes — et découvrez les options disponibles sur chaque page \* \[Collections\](/docs/documentation/fr/creation-de-contenu/content-structure/collection.md): Organisez vos espaces en dossiers \* \[Blocs\](/docs/documentation/fr/creation-de-contenu/blocks.md): Ajouter et modifier des blocs dans votre contenu \* \[Paragraphes\](/docs/documentation/fr/creation-de-contenu/blocks/paragraph.md): Ajoutez un bloc paragraphe pour insérer du texte formaté, des images en ligne et plus \* \[Titres\](/docs/documentation/fr/creation-de-contenu/blocks/heading.md): Ajoutez des blocs de titre à une page pour organiser votre contenu et améliorer le SEO \* \[Listes non ordonnées\](/docs/documentation/fr/creation-de-contenu/blocks/unordered-list.md): Ajoutez un bloc de liste non ordonnée pour créer des listes à puces \* \[Listes ordonnées\](/docs/documentation/fr/creation-de-contenu/blocks/ordered-list.md): Ajoutez une liste ordonnée ou numérotée à une page \* \[Listes de tâches\](/docs/documentation/fr/creation-de-contenu/blocks/task-list.md): Ajoutez une liste de tâches pour afficher des tâches pouvant être accomplies \* \[Conseils\](/docs/documentation/fr/creation-de-contenu/blocks/hint.md): Ajoutez un conseil à une page pour attirer l'attention du lecteur sur des informations importantes spécifiques. \* \[Citations\](/docs/documentation/fr/creation-de-contenu/blocks/quote.md): Ajoutez un bloc citation à une page pour mettre en évidence un texte provenant d'ailleurs, ou pour attirer l'attention sur une partie spécifique de votre texte \* \[Blocs de code\](/docs/documentation/fr/creation-de-contenu/blocks/code-block.md): Ajoutez un bloc de code à une page pour inclure des exemples de code, des configurations, des extraits de code et plus \* \[Fichiers\](/docs/documentation/fr/creation-de-contenu/blocks/insert-files.md): Gérez et ajoutez des fichiers à votre espace tels que PDFs, vidéos, documents et plus \* \[Images\](/docs/documentation/fr/creation-de-contenu/blocks/insert-images.md): Ajoutez une image ou une galerie d'images à une page, ajoutez des variantes d'image pour le mode sombre, et redimensionnez et alignez les images selon vos besoins \* \[URLs intégrées\](/docs/documentation/fr/creation-de-contenu/blocks/embed-a-url.md): Intégrez des vidéos, de la musique et plus directement dans votre page avec une URL \* \[Tableaux\](/docs/documentation/fr/creation-de-contenu/blocks/table.md): Gardez les informations organisées et facilitez la documentation des données avec des tableaux \* \[Cartes\](/docs/documentation/fr/creation-de-contenu/blocks/cards.md): Affichez des informations de manière plus dynamique avec un ensemble de cartes — avec ou sans images \* \[Onglets\](/docs/documentation/fr/creation-de-contenu/blocks/tabs.md): Ajoutez des onglets pour afficher de grandes sections d'informations liées sans créer une page longue et difficile à naviguer \* \[Déroulable\](/docs/documentation/fr/creation-de-contenu/blocks/expandable.md): Ajoutez un bloc déroulable à une page pour garder vos pages plus courtes, masquer du contenu long, ou créer des FAQ \* \[Guide pas à pas\](/docs/documentation/fr/creation-de-contenu/blocks/stepper.md): Ajoutez un guide étape par étape à une page — parfait pour les guides, les parcours et les processus de dépannage technique \* \[Dessins\](/docs/documentation/fr/creation-de-contenu/blocks/drawing.md): Créez des dessins dans GitBook et ajoutez-les à votre page \* \[Mathématiques & TeX\](/docs/documentation/fr/creation-de-contenu/blocks/math-and-tex.md): Ajoutez un bloc mathTeX à une page lorsque vous souhaitez afficher une formule mathématique dans votre documentation \* \[Liens de page\](/docs/documentation/fr/creation-de-contenu/blocks/page-link.md): Ajoutez un bloc de lien de page pour montrer les relations entre les pages de votre espace. \* \[Colonnes\](/docs/documentation/fr/creation-de-contenu/blocks/columns.md): Ajoutez une colonne pour créer différentes mises en page dans votre documentation. \* \[Contenu conditionnel\](/docs/documentation/fr/creation-de-contenu/blocks/conditional-content.md) \* \[Variables et expressions\](/docs/documentation/fr/creation-de-contenu/variables-and-expressions.md): Créez des variables réutilisables qui peuvent être référencées dans les pages et les espaces \* \[Contenu réutilisable\](/docs/documentation/fr/creation-de-contenu/reusable-content.md): Créez des blocs de contenu réutilisables pouvant être utilisés dans plusieurs espaces, et tous mis à jour en même temps lorsque vous modifiez une instance \* \[Recherche dans le contenu interne\](/docs/documentation/fr/creation-de-contenu/searching-your-content.md): Trouvez ce que vous cherchez plus rapidement grâce à la recherche par mot-clé et à la recherche intelligente alimentée par l'IA \* \[Recherche & recherche rapide\](/docs/documentation/fr/creation-de-contenu/searching-your-content/quick-find.md): Recherchez et naviguez rapidement dans votre documentation avec la recherche rapide \* \[GitBook IA\](/docs/documentation/fr/creation-de-contenu/searching-your-content/gitbook-ai.md): GitBook utilise l'IA pour vous aider à trouver plus rapidement les connaissances dont vous avez besoin au sein de votre organisation \* \[Rédaction avec GitBook IA\](/docs/documentation/fr/creation-de-contenu/write-and-edit-with-ai.md): Utilisez GitBook IA pour générer et créer du contenu pour votre page \* \[Contrôle de version\](/docs/documentation/fr/creation-de-contenu/version-control.md): Suivez les modifications, revenez à une version précédente et plus \* \[Traductions\](/docs/documentation/fr/creation-de-contenu/translations.md): Traduisez automatiquement votre contenu en plusieurs langues à l'aide de l'IA et maintenez-le synchronisé \* \[OpenAPI\](/docs/documentation/fr/references-api/openapi.md): Ajoutez une spécification OpenAPI à une page et laissez vos utilisateurs tester des endpoints directement sur la page avec des blocs interactifs. \* \[Ajouter une spécification OpenAPI\](/docs/documentation/fr/references-api/openapi/add-an-openapi-specification.md): Apprenez comment ajouter et mettre à jour une spécification OpenAPI dans l'application GitBook ou depuis le CLI \* \[Insérer la référence API dans votre documentation\](/docs/documentation/fr/references-api/openapi/insert-api-reference-in-your-docs.md): Insérez la référence API complète depuis votre spécification OpenAPI ou choisissez des opérations ou schémas individuels \* \[Guides\](/docs/documentation/fr/references-api/guides.md) \* \[Structuration de votre référence API\](/docs/documentation/fr/references-api/guides/structuring-your-api-reference.md): Apprenez comment structurer votre référence API sur plusieurs pages avec des icônes et des descriptions \* \[Ajout d'exemples de code personnalisés\](/docs/documentation/fr/references-api/guides/adding-custom-code-samples.md): Apprenez comment configurer des exemples de code personnalisés à afficher aux côtés de vos endpoints API \* \[Gestion des opérations API\](/docs/documentation/fr/references-api/guides/managing-api-operations.md): Apprenez comment marquer une opération API OpenAPI comme expérimentale, obsolète ou la masquer de votre documentation \* \[Configuration du bouton « Testez-le »\](/docs/documentation/fr/references-api/guides/configuring-the-test-it-button.md) \* \[Description des énumérations\](/docs/documentation/fr/references-api/guides/describing-enums.md): Apprenez comment ajouter des descriptions aux énumérations \* \[Intégration avec CI/CD\](/docs/documentation/fr/references-api/guides/support-for-ci-cd-with-api-blocks.md): Apprenez comment automatiser la mise à jour de votre spécification OpenAPI dans GitBook \* \[Référence des extensions\](/docs/documentation/fr/references-api/extensions-reference.md): La référence complète des extensions OpenAPI prises en charge par GitBook \* \[Publier un site de documentation\](/docs/documentation/fr/publication-de-documentation/publish-a-docs-site.md): Publiez votre documentation sur Internet en tant que site de documentation \* \[Publication publique\](/docs/documentation/fr/publication-de-documentation/publish-a-docs-site/public-publishing.md): Publiez vos docs publiquement sur le Web afin que tout le monde puisse y accéder \* \[Publication privée avec liens de partage\](/docs/documentation/fr/publication-de-documentation/publish-a-docs-site/share-links.md): Ajoutez un contrôle renforcé sur qui peut voir votre documentation GitBook publiée \* \[Structure du site\](/docs/documentation/fr/publication-de-documentation/site-structure.md): Ajoutez de la structure à votre documentation publiée en utilisant des sections de site et des variantes \* \[Sections du site\](/docs/documentation/fr/publication-de-documentation/site-structure/site-sections.md): Ajoutez plusieurs produits à votre site en tant que sections et créez un hub de contenu avec des onglets pour accéder à tout votre contenu \* \[Variantes de contenu\](/docs/documentation/fr/publication-de-documentation/site-structure/variants.md): Publiez de la documentation pour plusieurs versions de produit ou langues dans un seul site \* \[Personnalisation du site\](/docs/documentation/fr/publication-de-documentation/customization.md): Créez une documentation de marque avec un logo personnalisé, polices, couleurs, liens et plus \* \[Icônes, couleurs et thèmes\](/docs/documentation/fr/publication-de-documentation/customization/icons-colors-and-themes.md): Personnalisez les icônes, couleurs, thèmes et plus \* \[Mise en page et structure\](/docs/documentation/fr/publication-de-documentation/customization/layout-and-structure.md): Personnalisez la mise en page et la structure de votre documentation publiée \* \[Configuration supplémentaire\](/docs/documentation/fr/publication-de-documentation/customization/extra-configuration.md): Configurez des options supplémentaires pour votre documentation publiée \* \[Définir un domaine personnalisé\](/docs/documentation/fr/publication-de-documentation/custom-domain.md): Définissez un domaine personnalisé pour vos sites de documentation \* \[Définir un sous-répertoire personnalisé\](/docs/documentation/fr/publication-de-documentation/setting-a-custom-subdirectory.md): Définissez un sous-répertoire personnalisé pour vos sites de documentation \* \[Configuration d'un sous-répertoire avec Cloudflare\](/docs/documentation/fr/publication-de-documentation/setting-a-custom-subdirectory/configuring-a-subdirectory-with-cloudflare.md): Hébergez votre documentation avec un sous-répertoire /docs en utilisant Cloudflare \* \[Configuration d'un sous-répertoire avec Vercel\](/docs/documentation/fr/publication-de-documentation/setting-a-custom-subdirectory/configuring-a-subdirectory-with-vercel.md): Hébergez votre documentation avec un sous-répertoire /docs en utilisant Vercel \* \[Configuration d'un sous-répertoire avec AWS en utilisant CloudFront et Route 53\](/docs/documentation/fr/publication-de-documentation/setting-a-custom-subdirectory/configuring-a-subdirectory-with-aws.md): Hébergez votre documentation avec un sous-répertoire /docs en utilisant AWS CloudFront et Route 53. \* \[Paramètres du site\](/docs/documentation/fr/publication-de-documentation/site-settings.md): Personnalisez et modifiez les paramètres de votre site publié \* \[Insights du site\](/docs/documentation/fr/publication-de-documentation/insights.md): Consultez les analyses et insights liés au trafic de votre documentation publiée \* \[Redirections du site\](/docs/documentation/fr/publication-de-documentation/site-redirects.md): Configurez des redirections de site pour acheminer le trafic vers du contenu n'importe où sur votre site \* \[Accès authentifié\](/docs/documentation/fr/publication-de-documentation/authenticated-access.md): Configurez une authentification personnalisée pour votre contenu publié \* \[Activation de l'accès authentifié\](/docs/documentation/fr/publication-de-documentation/authenticated-access/enabling-authenticated-access.md) \* \[Configuration d'Auth0\](/docs/documentation/fr/publication-de-documentation/authenticated-access/setting-up-auth0.md): Configurez un écran de connexion Auth0 pour les visiteurs de votre documentation \* \[Configuration d'Azure AD\](/docs/documentation/fr/publication-de-documentation/authenticated-access/setting-up-azure-ad.md): Configurez un écran de connexion Azure AD pour les visiteurs de votre documentation \* \[Configuration d'AWS Cognito\](/docs/documentation/fr/publication-de-documentation/authenticated-access/setting-up-aws-cognito.md): Configurez un écran de connexion AWS Cognito pour les visiteurs de votre documentation \* \[Configuration d'Okta\](/docs/documentation/fr/publication-de-documentation/authenticated-access/setting-up-okta.md): Configurez un écran de connexion Okta pour les visiteurs de votre documentation \* \[Configuration d'OIDC\](/docs/documentation/fr/publication-de-documentation/authenticated-access/setting-up-oidc.md): Configurez un écran de connexion OIDC pour les visiteurs de votre documentation \* \[Configuration d'un backend personnalisé\](/docs/documentation/fr/publication-de-documentation/authenticated-access/setting-up-a-custom-backend.md): Configurez un écran de connexion personnalisé pour les visiteurs de votre documentation \* \[Contenu adaptatif\](/docs/documentation/fr/publication-de-documentation/adaptive-content.md): Offrez une expérience de documentation adaptée selon qui lit \* \[Activation du contenu adaptatif\](/docs/documentation/fr/publication-de-documentation/adaptive-content/enabling-adaptive-content.md): Choisissez une méthode d'authentification pour transmettre les données utilisateur à GitBook \* \[Cookies\](/docs/documentation/fr/publication-de-documentation/adaptive-content/enabling-adaptive-content/cookies.md): Transmettez les données des visiteurs dans vos docs via un cookie public ou signé \* \[URL\](/docs/documentation/fr/publication-de-documentation/adaptive-content/enabling-adaptive-content/url.md): Transmettez les données des visiteurs dans vos docs via des paramètres de requête URL \* \[Drapeaux de fonctionnalité\](/docs/documentation/fr/publication-de-documentation/adaptive-content/enabling-adaptive-content/feature-flags.md): Transmettez les données des visiteurs dans vos docs via un fournisseur de feature flags \* \[Accès authentifié\](/docs/documentation/fr/publication-de-documentation/adaptive-content/enabling-adaptive-content/authenticated-access.md) \* \[Adapter votre contenu\](/docs/documentation/fr/publication-de-documentation/adaptive-content/adapting-your-content.md): Adaptez votre contenu pour différents utilisateurs \* \[Test avec des segments\](/docs/documentation/fr/publication-de-documentation/adaptive-content/testing-with-segments.md): Testez vos conditions avec des données factices \* \[Recherche IA\](/docs/documentation/fr/publication-de-documentation/ai-search.md): Aidez vos utilisateurs à trouver l'information dont ils ont besoin plus rapidement grâce à de puissants outils de recherche IA pour votre contenu publié \* \[Assistant GitBook\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant.md): GitBook Assistant offre aux utilisateurs des réponses basées sur votre documentation et adaptées à leur situation — pas seulement des réponses génériques \* \[Intégration\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/embedding.md): Choisissez la méthode d'intégration qui correspond le mieux à votre pile technologique et à vos besoins d'intégration \* \[Balise script\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/embedding/script.md): Ajoutez GitBook Assistant à n'importe quel site Web avec une simple balise script \* \[Node.js/NPM\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/embedding/nodejs.md): Intégrez GitBook Assistant en utilisant le paquet NPM pour un contrôle complet au niveau de l'application \* \[React\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/embedding/react.md): Utilisez des composants React préconstruits pour intégrer GitBook Assistant à votre application React \* \[Authentification\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/using-with-authenticated-docs.md): Intégrez GitBook Assistant sur des sites nécessitant une authentification en chargeant dynamiquement le script après la connexion des utilisateurs \* \[Configuration\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/configuration.md) \* \[Personnalisation de l'Assistant\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/configuration/customizing-gitbook-assistant.md): Personnalisez l'expérience lors de l'intégration de GitBook Assistant dans votre produit ou application en définissant des messages de bienvenue, des boutons et plus encore \* \[Création d'outils personnalisés\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/configuration/creating-custom-tools.md): Ajoutez des outils personnalisés à GitBook Assistant pour lui permettre d'interagir avec votre produit, site Web, et plus encore \* \[Référence\](/docs/documentation/fr/publication-de-documentation/gitbook-ai-assistant/configuration/reference.md): En savoir plus sur les méthodes disponibles pour travailler programmatiquement avec GitBook Assistant \* \[Docs prêts pour LLM\](/docs/documentation/fr/publication-de-documentation/llm-ready-docs.md): Fournir une version de votre site de docs adaptée aux LLM \* \[Serveurs MCP pour les docs publiés\](/docs/documentation/fr/publication-de-documentation/mcp-servers-for-published-docs.md): Les docs publiés sur GitBook génèrent automatiquement un serveur MCP que vous pouvez connecter à des outils externes \* \[Éditions en direct\](/docs/documentation/fr/collaboration/live-edits.md): Éditez des pages en temps réel avec d'autres collaborateurs \* \[Demandes de modification\](/docs/documentation/fr/collaboration/change-requests.md): Collaborez sur les modifications de contenu via des demandes de modification \* \[Export PDF\](/docs/documentation/fr/collaboration/pdf-export.md): Exportez une copie PDF de votre contenu GitBook \* \[Inviter votre équipe\](/docs/documentation/fr/collaboration/share.md): Collaborez avec vos coéquipiers sur les espaces, collections et plus \* \[Règles de fusion\](/docs/documentation/fr/collaboration/merge-rules.md): Définissez les exigences qui doivent être remplies avant que les demandes de modification puissent être fusionnées \* \[Commentaires\](/docs/documentation/fr/collaboration/comments.md): Posez des questions à votre équipe ou recevez des retours sur le contenu que vous créez \* \[Notifications\](/docs/documentation/fr/collaboration/notifications.md): Recevez des notifications sur le nouveau contenu, les mises à jour de vos espaces ou les changements de visibilité \* \[Installer et gérer les intégrations\](/docs/documentation/fr/integrations/install-an-integration.md): Installez une intégration dans un seul espace, ou dans tous les espaces de votre organisation \* \[Forfaits\](/docs/documentation/fr/gestion-du-compte/plans.md): Découvrez les différences entre les forfaits proposés par GitBook \* \[Forfait Communautaire\](/docs/documentation/fr/gestion-du-compte/plans/community.md): Postulez à notre forfait Open Source sur GitBook \* \[Forfait site sponsorisé\](/docs/documentation/fr/gestion-du-compte/plans/community/sponsored-site-plan.md): En savoir plus sur la façon dont vous pouvez gagner de l'argent avec votre site de documentation grâce à notre forfait site sponsorisé \* \[Politique de facturation\](/docs/documentation/fr/gestion-du-compte/plans/billing-policy.md) \* \[Annulations d'abonnement\](/docs/documentation/fr/gestion-du-compte/cancelling-a-plan.md): Annulez votre abonnement \* \[Paramètres personnels\](/docs/documentation/fr/gestion-du-compte/account-settings.md): Consultez et gérez les paramètres de votre compte GitBook personnel \* \[Paramètres de l'organisation\](/docs/documentation/fr/gestion-du-compte/organization-settings.md): Apprenez comment gérer votre organisation dans GitBook \* \[Gestion des membres\](/docs/documentation/fr/gestion-du-compte/member-management.md): Apprenez comment gérer l'accès au contenu pour les membres de votre organisation \* \[Inviter ou supprimer des membres\](/docs/documentation/fr/gestion-du-compte/member-management/invite-members-to-your-organization.md) \* \[Rôles\](/docs/documentation/fr/gestion-du-compte/member-management/roles.md) \* \[Équipes\](/docs/documentation/fr/gestion-du-compte/member-management/teams.md): Les équipes sont un excellent moyen de regrouper des membres au sein de votre organisation \* \[Permissions et héritage\](/docs/documentation/fr/gestion-du-compte/member-management/permissions-and-inheritance.md) \* \[SSO & SAML\](/docs/documentation/fr/gestion-du-compte/sso-and-saml.md): Apprenez comment partager votre contenu GitBook via SSO & SAML \* \[Membres SSO vs non-SSO\](/docs/documentation/fr/gestion-du-compte/sso-and-saml/sso-members-vs-non-sso.md) \* \[Interface GitBook\](/docs/documentation/fr/ressources/gitbook-ui.md): Découvrez les différents composants et l'interface dans l'éditeur de GitBook \* \[Barre d'outils sur les sites publiés et les aperçus de site\](/docs/documentation/fr/ressources/gitbook-ui/toolbar-on-published-sites-and-site-previews.md) \* \[Raccourcis clavier\](/docs/documentation/fr/ressources/keyboard-shortcuts.md): Un guide de référence rapide de tous les raccourcis clavier disponibles dans GitBook \* \[Glossaire\](/docs/documentation/fr/ressources/glossary.md) - \[GitBook 文档\](/docs/documentation/zh/ru-men/readme.md): 创建并发布用户会喜爱的精美文档。GitBook 拥有创建从产品指南到 API 参考等各种文档所需的所有工具。 - \[快速开始\](/docs/documentation/zh/ru-men/quickstart.md): 在 GitBook 中快速上手，并在几分钟内发布您的第一个文档站点 - \[概念\](/docs/documentation/zh/ru-men/gai-nian.md): 了解基础知识，以便您为用户创建并发布出色的文档 - \[迁移到 GitBook\](/docs/documentation/zh/ru-men/import.md): 如何将现有内容从 Confluence、Notion、Git 等导入到 GitBook - \[原生 AI 功能\](/docs/documentation/zh/ru-men/ai-documentation.md): 了解 AI 文档如何帮助用户找到答案、帮助团队高效维护文档，以及让您的文档更易被像 ChatGPT 这样的 AI 工具发现 - \[GitHub 与 GitLab 同步\](/docs/documentation/zh/ru-men/git-sync.md): 使用 GitBook 的双向集成将您的 GitBook 内容与 GitHub 或 GitLab 同步 - \[启用 GitHub 同步\](/docs/documentation/zh/ru-men/git-sync/enabling-github-sync.md): 为 GitBook 设置并授权 GitHub 集成 - \[启用 GitLab 同步\](/docs/documentation/zh/ru-men/git-sync/enabling-gitlab-sync.md): 为 GitBook 设置并授权 GitLab 集成 - \[内容配置\](/docs/documentation/zh/ru-men/git-sync/content-configuration.md): 使用额外功能配置 Git 同步 - \[GitHub 拉取请求预览\](/docs/documentation/zh/ru-men/git-sync/github-pull-request-preview.md): 在 GitHub 中发起拉取请求时查看内容预览 - \[提交信息与自动链接\](/docs/documentation/zh/ru-men/git-sync/commits.md) - \[单一仓库（Monorepos）\](/docs/documentation/zh/ru-men/git-sync/monorepos.md) - \[故障排除\](/docs/documentation/zh/ru-men/git-sync/troubleshooting.md) - \[格式化您的内容\](/docs/documentation/zh/chuang-jian-nei-rong/formatting.md): 使用上下文菜单或键盘快捷键以多种方式格式化您的内容 - \[内联内容\](/docs/documentation/zh/chuang-jian-nei-rong/formatting/inline.md): 使用内联调色板添加图像、链接、数学与 TeX 等内容 - \[Markdown\](/docs/documentation/zh/chuang-jian-nei-rong/formatting/markdown.md): 在编辑器中直接编写 Markdown，使用常见语法轻松创建内容 - \[内容结构\](/docs/documentation/zh/chuang-jian-nei-rong/content-structure.md): 创建页面、空间和集合 - \[空间\](/docs/documentation/zh/chuang-jian-nei-rong/content-structure/space.md): 将您创建和发布的内容组织到空间中 - \[页面\](/docs/documentation/zh/chuang-jian-nei-rong/content-structure/page.md): 添加页面、页面组或外部链接 — 并了解每个页面的可用选项 - \[集合\](/docs/documentation/zh/chuang-jian-nei-rong/content-structure/collection.md): 将您的空间组织成文件夹 - \[区块\](/docs/documentation/zh/chuang-jian-nei-rong/blocks.md): 在内容中添加和编辑区块 - \[段落\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/paragraph.md): 添加段落区块以插入格式化文本、内联图像等 - \[标题\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/heading.md): 向页面添加标题区块以组织内容并改善 SEO - \[无序列表\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/unordered-list.md): 添加无序列表区块以创建要点列表 - \[有序列表\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/ordered-list.md): 向页面添加有序或编号列表 - \[任务列表\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/task-list.md): 添加任务列表以显示可以完成的任务 - \[提示\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/hint.md): 向页面添加提示以将读者的注意力吸引到重要信息的特定部分。 - \[引用\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/quote.md): 向页面添加引用区块以突出显示从其他地方添加的文本，或强调文本的特定部分 - \[代码区块\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/code-block.md): 向页面添加代码区块以包含示例代码、配置、代码片段等 - \[文件\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-files.md): 管理并向您的空间添加文件，例如 PDF、视频、文档等 - \[图像\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/insert-images.md): 向页面添加图像或图像画廊，为深色模式添加图像变体，并根据需要调整图像大小和对齐 - \[嵌入的 URL\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/embed-a-url.md): 通过 URL 将视频、音乐等直接嵌入到页面中 - \[表格\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/table.md): 使用表格保持信息有序，使文档化数据更容易 - \[卡片\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/cards.md): 使用一组卡片更动态地展示信息 — 可包含或不包含图像 - \[选项卡\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/tabs.md): 添加选项卡，以便在不创建冗长且难以导航的页面的情况下显示大量相关信息块 - \[可展开\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/expandable.md): 向页面添加可展开区块以缩短页面、隐藏较长内容或创建常见问题解答 - \[步骤器\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/stepper.md): 向页面添加分步骤指南——非常适合指南、演练和技术故障排除流程 - \[绘图\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/drawing.md): 在 GitBook 中创建绘图并将其添加到页面 - \[数学与 TeX\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/math-and-tex.md): 当您希望在文档中显示数学公式时，向页面添加 mathTeX 区块 - \[页面链接\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/page-link.md): 添加页面链接区块以显示您空间中页面之间的关联。 - \[列\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/columns.md): 添加列以在文档中创建不同的布局。 - \[条件内容\](/docs/documentation/zh/chuang-jian-nei-rong/blocks/conditional-content.md) - \[变量与表达式\](/docs/documentation/zh/chuang-jian-nei-rong/variables-and-expressions.md): 创建可在页面和空间中引用的可重用变量 - \[可重用内容\](/docs/documentation/zh/chuang-jian-nei-rong/reusable-content.md): 创建可跨空间使用的可重用内容块，在更改某个实例时可同时更新所有内容 - \[搜索内部内容\](/docs/documentation/zh/chuang-jian-nei-rong/searching-your-content.md): 通过关键字搜索和 AI 驱动的智能搜索更快地找到所需内容 - \[搜索与快速查找\](/docs/documentation/zh/chuang-jian-nei-rong/searching-your-content/quick-find.md): 使用快速查找快速搜索并导航您的文档 - \[GitBook AI\](/docs/documentation/zh/chuang-jian-nei-rong/searching-your-content/gitbook-ai.md): GitBook 使用 AI 帮助您更快地在组织内部找到所需知识 - \[使用 GitBook AI 撰写\](/docs/documentation/zh/chuang-jian-nei-rong/write-and-edit-with-ai.md): 使用 GitBook AI 为您的页面生成和构建内容 - \[版本控制\](/docs/documentation/zh/chuang-jian-nei-rong/version-control.md): 跟踪更改、回滚到以前版本等 - \[翻译\](/docs/documentation/zh/chuang-jian-nei-rong/translations.md): 使用 AI 将内容自动翻译成多种语言并保持同步 - \[OpenAPI\](/docs/documentation/zh/api-can-kao/openapi.md): 将 OpenAPI 规范添加到页面，并让您的用户在页面上通过交互区块直接测试端点。 - \[添加 OpenAPI 规范\](/docs/documentation/zh/api-can-kao/openapi/add-an-openapi-specification.md): 了解如何在 GitBook 应用中或通过 CLI 添加和更新 OpenAPI 规范 - \[在文档中插入 API 参考\](/docs/documentation/zh/api-can-kao/openapi/insert-api-reference-in-your-docs.md): 从您的 OpenAPI 规范插入完整的 API 参考，或选择单个操作或模式 - \[指南\](/docs/documentation/zh/api-can-kao/guides.md) - \[构建 API 参考的结构\](/docs/documentation/zh/api-can-kao/guides/structuring-your-api-reference.md): 了解如何使用图标和描述在多页中构建您的 API 参考结构 - \[添加自定义代码示例\](/docs/documentation/zh/api-can-kao/guides/adding-custom-code-samples.md): 了解如何配置自定义代码示例以与您的 API 端点一起显示 - \[管理 API 操作\](/docs/documentation/zh/api-can-kao/guides/managing-api-operations.md): 了解如何将 OpenAPI 的 API 操作标记为实验性的、弃用的或将其从文档中隐藏 - \[配置“测试它”按钮\](/docs/documentation/zh/api-can-kao/guides/configuring-the-test-it-button.md) - \[描述枚举\](/docs/documentation/zh/api-can-kao/guides/describing-enums.md): 了解如何为枚举添加描述 - \[与 CI/CD 集成\](/docs/documentation/zh/api-can-kao/guides/support-for-ci-cd-with-api-blocks.md): 了解如何在 GitBook 中自动更新您的 OpenAPI 规范 - \[扩展参考\](/docs/documentation/zh/api-can-kao/extensions-reference.md): GitBook 支持的 OpenAPI 扩展完整参考 - \[发布文档站点\](/docs/documentation/zh/fa-bu-wen-dang/publish-a-docs-site.md): 将您的文档发布到互联网上作为文档站点 - \[公开发布\](/docs/documentation/zh/fa-bu-wen-dang/publish-a-docs-site/public-publishing.md): 将您的文档公开发布到 Web，使所有人都能访问 - \[通过分享链接进行私人发布\](/docs/documentation/zh/fa-bu-wen-dang/publish-a-docs-site/share-links.md): 对谁可以查看已发布的 GitBook 文档添加更严格的控制 - \[站点结构\](/docs/documentation/zh/fa-bu-wen-dang/site-structure.md): 使用站点部分和变体为已发布文档添加结构 - \[站点部分\](/docs/documentation/zh/fa-bu-wen-dang/site-structure/site-sections.md): 将多个产品作为站点部分添加到您的站点，并创建带选项卡的内容中心以访问所有内容 - \[内容变体\](/docs/documentation/zh/fa-bu-wen-dang/site-structure/variants.md): 在单个站点中为多个产品版本或语言发布文档 - \[站点自定义\](/docs/documentation/zh/fa-bu-wen-dang/customization.md): 通过自定义徽标、字体、颜色、链接等创建品牌化文档 - \[图标、颜色与主题\](/docs/documentation/zh/fa-bu-wen-dang/customization/icons-colors-and-themes.md): 自定义图标、颜色、主题等 - \[布局与结构\](/docs/documentation/zh/fa-bu-wen-dang/customization/layout-and-structure.md): 自定义已发布文档的布局与结构 - \[额外配置\](/docs/documentation/zh/fa-bu-wen-dang/customization/extra-configuration.md): 为已发布文档配置额外选项 - \[设置自定义域名\](/docs/documentation/zh/fa-bu-wen-dang/custom-domain.md): 为您的文档站点设置自定义域名 - \[设置自定义子目录\](/docs/documentation/zh/fa-bu-wen-dang/setting-a-custom-subdirectory.md): 为您的文档站点设置自定义子目录 - \[使用 Cloudflare 配置子目录\](/docs/documentation/zh/fa-bu-wen-dang/setting-a-custom-subdirectory/configuring-a-subdirectory-with-cloudflare.md): 使用 Cloudflare 将您的文档托管在 /docs 子目录下 - \[使用 Vercel 配置子目录\](/docs/documentation/zh/fa-bu-wen-dang/setting-a-custom-subdirectory/configuring-a-subdirectory-with-vercel.md): 使用 Vercel 将您的文档托管在 /docs 子目录下 - \[使用 CloudFront 和 Route 53 在 AWS 上配置子目录\](/docs/documentation/zh/fa-bu-wen-dang/setting-a-custom-subdirectory/configuring-a-subdirectory-with-aws.md): 使用 AWS CloudFront 和 Route 53 将您的文档托管在 /docs 子目录下。 - \[站点设置\](/docs/documentation/zh/fa-bu-wen-dang/site-settings.md): 自定义并编辑已发布站点的设置 - \[站点洞察\](/docs/documentation/zh/fa-bu-wen-dang/insights.md): 查看与已发布文档流量相关的分析与洞察 - \[站点重定向\](/docs/documentation/zh/fa-bu-wen-dang/site-redirects.md): 设置站点重定向以将流量路由到站点上的任何内容 - \[验证访问\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access.md): 为已发布内容设置自定义身份验证 - \[启用已验证访问\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/enabling-authenticated-access.md) - \[设置 Auth0\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/setting-up-auth0.md): 为访问您文档的访客设置 Auth0 登录界面 - \[设置 Azure AD\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/setting-up-azure-ad.md): 为访问您文档的访客设置 Azure AD 登录界面 - \[设置 AWS Cognito\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/setting-up-aws-cognito.md): 为访问您文档的访客设置 AWS Cognito 登录界面 - \[设置 Okta\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/setting-up-okta.md): 为访问您文档的访客设置 Okta 登录界面 - \[设置 OIDC\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/setting-up-oidc.md): 为访问您文档的访客设置 OIDC 登录界面 - \[设置自定义后端\](/docs/documentation/zh/fa-bu-wen-dang/authenticated-access/setting-up-a-custom-backend.md): 为访问您文档的访客设置自定义登录界面 - \[自适应内容\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content.md): 根据阅读者身份提供定制化的文档体验 - \[启用自适应内容\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/enabling-adaptive-content.md): 选择一种身份验证方法以将用户数据传递给 GitBook - \[Cookies（Cookie）\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/enabling-adaptive-content/cookies.md): 通过公共或签名 cookie 将访客数据传入您的文档 - \[URL\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/enabling-adaptive-content/url.md): 通过 URL 查询参数将访客数据传入您的文档 - \[功能标志\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/enabling-adaptive-content/feature-flags.md): 通过功能标志提供者将访客数据传入您的文档 - \[验证访问\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/enabling-adaptive-content/authenticated-access.md) - \[自适应您的内容\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/adapting-your-content.md): 为不同用户量身定制您的内容 - \[使用分段进行测试\](/docs/documentation/zh/fa-bu-wen-dang/adaptive-content/testing-with-segments.md): 使用模拟数据测试您的条件 - \[AI 搜索\](/docs/documentation/zh/fa-bu-wen-dang/ai-search.md): 使用强大的 AI 搜索工具帮助用户更快地在已发布内容中找到所需信息 - \[GitBook 助手\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant.md): GitBook Assistant 根据您的文档并结合用户的具体情况为用户提供回答——而不是仅给出通用回复 - \[嵌入\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/embedding.md): 选择最适合您的技术栈和集成需求的嵌入方法 - \[脚本标签\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/embedding/script.md): 通过简单的脚本标签将 GitBook Assistant 添加到任何网站 - \[Node.js/NPM\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/embedding/nodejs.md): 使用 NPM 包集成 GitBook Assistant，以实现完整的应用级控制 - \[React\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/embedding/react.md): 使用预构建的 React 组件将 GitBook Assistant 嵌入到您的 React 应用中 - \[身份验证\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/using-with-authenticated-docs.md): 通过在用户登录后动态加载脚本，将 GitBook Assistant 嵌入需要身份验证的网站 - \[配置\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/pei-zhi.md) - \[自定义 Assistant\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/pei-zhi/customizing-gitbook-assistant.md): 通过设置欢迎信息、按钮等，自定义将 GitBook Assistant 嵌入到您的产品或应用时的体验 - \[创建自定义工具\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/pei-zhi/creating-custom-tools.md): 向 GitBook Assistant 添加自定义工具，以便它与您的产品、网站等进行交互 - \[参考\](/docs/documentation/zh/fa-bu-wen-dang/gitbook-ai-assistant/pei-zhi/reference.md): 了解在以编程方式使用 GitBook Assistant 时可用的方法 - \[适配大型语言模型的文档\](/docs/documentation/zh/fa-bu-wen-dang/llm-ready-docs.md): 为您的文档站点提供对 LLM 友好的版本 - \[用于已发布文档的 MCP 服务器\](/docs/documentation/zh/fa-bu-wen-dang/mcp-servers-for-published-docs.md): 发布在 GitBook 上的文档会自动生成一个 MCP 服务器，您可以将其连接到外部工具 - \[实时编辑\](/docs/documentation/zh/xie-zuo/live-edits.md): 与其他协作者实时编辑页面 - \[变更请求\](/docs/documentation/zh/xie-zuo/change-requests.md): 通过变更请求协作编辑内容 - \[PDF 导出\](/docs/documentation/zh/xie-zuo/pdf-export.md): 导出您的 GitBook 内容为 PDF 副本 - \[邀请您的团队\](/docs/documentation/zh/xie-zuo/share.md): 与您的团队在空间、集合等方面协作 - \[合并规则\](/docs/documentation/zh/xie-zuo/merge-rules.md): 定义在合并变更请求之前必须满足的要求 - \[评论\](/docs/documentation/zh/xie-zuo/comments.md): 向团队提问或接收对您创建内容的反馈 - \[通知\](/docs/documentation/zh/xie-zuo/notifications.md): 接收有关新内容、空间更新或可见性更改的通知 - \[安装并管理集成\](/docs/documentation/zh/ji-cheng/install-an-integration.md): 在单个空间或组织的所有空间中安装集成 - \[计划\](/docs/documentation/zh/zhang-hu-guan-li/plans.md): 了解 GitBook 各计划之间的差异 - \[社区计划\](/docs/documentation/zh/zhang-hu-guan-li/plans/community.md): 在 GitBook 申请我们的开源计划 - \[赞助站点计划\](/docs/documentation/zh/zhang-hu-guan-li/plans/community/sponsored-site-plan.md): 了解有关如何通过我们的赞助站点计划从文档站点中赚取收入的更多信息 - \[计费政策\](/docs/documentation/zh/zhang-hu-guan-li/plans/billing-policy.md) - \[订阅取消\](/docs/documentation/zh/zhang-hu-guan-li/cancelling-a-plan.md): 取消您的订阅 - \[个人设置\](/docs/documentation/zh/zhang-hu-guan-li/account-settings.md): 查看并管理您个人 GitBook 帐户的设置 - \[组织设置\](/docs/documentation/zh/zhang-hu-guan-li/organization-settings.md): 了解如何在 GitBook 中管理您的组织 - \[成员管理\](/docs/documentation/zh/zhang-hu-guan-li/member-management.md): 了解如何管理组织成员对内容的访问权限 - \[邀请或移除成员\](/docs/documentation/zh/zhang-hu-guan-li/member-management/invite-members-to-your-organization.md) - \[角色\](/docs/documentation/zh/zhang-hu-guan-li/member-management/roles.md) - \[团队\](/docs/documentation/zh/zhang-hu-guan-li/member-management/teams.md): 团队是将组织内成员分组的好方法 - \[权限与继承\](/docs/documentation/zh/zhang-hu-guan-li/member-management/permissions-and-inheritance.md) - \[SSO 与 SAML\](/docs/documentation/zh/zhang-hu-guan-li/sso-and-saml.md): 了解如何通过 SSO 与 SAML 共享您的 GitBook 内容 - \[SSO 成员与非 SSO 成员\](/docs/documentation/zh/zhang-hu-guan-li/sso-and-saml/sso-members-vs-non-sso.md) - \[GitBook 界面\](/docs/documentation/zh/zi-yuan/gitbook-ui.md): 了解 GitBook 编辑器中不同的组件与界面 - \[已发布站点和站点预览的工具栏\](/docs/documentation/zh/zi-yuan/gitbook-ui/toolbar-on-published-sites-and-site-previews.md) - \[键盘快捷键\](/docs/documentation/zh/zi-yuan/keyboard-shortcuts.md): GitBook 中所有可用键盘快捷键的速查指南 - \[术语表\](/docs/documentation/zh/zi-yuan/glossary.md) ## Developers - \[Developer documentation\](/docs/developers/readme.md): Use GitBook’s API, SDK, and developer tools to build custom integrations, streamline workflows, and create tailored solutions for your docs - \[Quickstart\](/docs/developers/integrations/quickstart.md): In this guide you’ll learn how to get up and running with GitBook’s developer platform in minutes - \[Install the CLI\](/docs/developers/integrations/reference.md): Install the GitBook CLI to build and publish integrations - \[CLI reference\](/docs/developers/integrations/reference/cli-reference.md): Explore the full reference guide for GitBook’s CLI commands - \[Configure your integration\](/docs/developers/integrations/configurations.md): Learn about the gitbook-manifest.yaml file your integration uses - \[Develop your integration\](/docs/developers/integrations/development.md): Develop and test integrations in GitBook - \[ContentKit\](/docs/developers/integrations/development/contentkit.md) - \[Component reference\](/docs/developers/integrations/development/contentkit/reference.md) - \[Integration runtime\](/docs/developers/integrations/development/runtime.md) - \[Client library\](/docs/developers/integrations/development/browser-node.md): GitBook's official Node.js client library - \[GitBook methods\](/docs/developers/integrations/development/browser-node/gitbook-methods.md): Available methods from the GitBook client library - \[Publish your integration\](/docs/developers/integrations/publishing.md): Publish your apps and integrations publicly or privately - \[Submit your integration for review\](/docs/developers/integrations/submit-your-app-for-review.md): List your integration on GitBook’s verified integration page - \[Concepts\](/docs/developers/integrations/concepts.md): Learn about different GitBook concepts related to GitBook integrations - \[Guides\](/docs/developers/integrations/guides.md) - \[Creating a custom unfurl action\](/docs/developers/integrations/guides/create-a-custom-unfurl-action-for-your-integration.md) - \[Creating interactive blocks\](/docs/developers/integrations/guides/interactivity.md): Add interactivity to custom blocks in GitBook integrations using inputs, buttons, and more - \[Referencing your integration in Markdown\](/docs/developers/integrations/guides/markdown.md) - \[Working with HTTP requests\](/docs/developers/integrations/guides/receiving-requests.md) - \[Using the CLI in CI/CD\](/docs/developers/integrations/guides/ci.md) - \[Receiving webhook notifications\](/docs/developers/integrations/guides/webhook.md) - \[Quickstart\](/docs/developers/gitbook-api/quickstart.md) - \[API reference\](/docs/developers/gitbook-api/api-reference.md): GitBook’s full API reference - \[Organizations\](/docs/developers/gitbook-api/api-reference/organizations.md): Manage your organizations and group your members, spaces, and resources under one collaborative structure. - \[Organization members\](/docs/developers/gitbook-api/api-reference/organizations/organization-members.md): Handle all aspects of membership within an organization, from listing to role management. - \[Organization invites\](/docs/developers/gitbook-api/api-reference/organizations/organization-invites.md): Streamline the invitation process for new members joining your organization. - \[Organization AI ask\](/docs/developers/gitbook-api/api-reference/organizations/organization-ai-ask.md): Unlock AI-driven answers for your organization's content and data. - \[Docs sites\](/docs/developers/gitbook-api/api-reference/docs-sites.md): Manage your published docs sites. - \[Site share links\](/docs/developers/gitbook-api/api-reference/docs-sites/site-share-links.md): Control how you share docs externally by managing share links for a site. - \[Site structure\](/docs/developers/gitbook-api/api-reference/docs-sites/site-structure.md): Retrieve and manipulate the entire hierarchical layout of a site. - \[Site auth\](/docs/developers/gitbook-api/api-reference/docs-sites/site-auth.md): Manage the authentication needed for publishing your site. - \[Site preview\](/docs/developers/gitbook-api/api-reference/docs-sites/site-preview.md): Fetch an up-to-date preview of your site before publishing. - \[Site customization\](/docs/developers/gitbook-api/api-reference/docs-sites/site-customization.md): Customize the look and feel of your docs site. - \[Site spaces\](/docs/developers/gitbook-api/api-reference/docs-sites/site-spaces.md): Control which spaces are linked and displayed in a docs site. - \[Site sections\](/docs/developers/gitbook-api/api-reference/docs-sites/site-sections.md): Create and organize high-level sections for your docs site. - \[Site section groups\](/docs/developers/gitbook-api/api-reference/docs-sites/site-section-groups.md): Group and manage sections of your docs for easier organization. - \[Site redirects\](/docs/developers/gitbook-api/api-reference/docs-sites/site-redirects.md): Establish redirects for pages that have moved or changed in your docs site. - \[Site MCP servers\](/docs/developers/gitbook-api/api-reference/docs-sites/site-mcp-servers.md): Configure external MCP servers used by your site. - \[Site ads\](/docs/developers/gitbook-api/api-reference/docs-sites/site-ads.md): Control and customize ad placements on your docs site. - \[Site users\](/docs/developers/gitbook-api/api-reference/docs-sites/site-users.md): Manage which users can access or contribute to a docs site. - \[Site insights\](/docs/developers/gitbook-api/api-reference/docs-sites/site-insights.md): Analyze traffic and engagement metrics for your docs site. - \[Site AI\](/docs/developers/gitbook-api/api-reference/docs-sites/site-ai.md): Build conversational AI agents for your docs site. - \[Site AI ask\](/docs/developers/gitbook-api/api-reference/docs-sites/site-ai-ask.md): Allow AI-driven queries within a specific docs site. - \[Collections\](/docs/developers/gitbook-api/api-reference/collections.md): Organize and manage grouped sets of spaces for better content structure. - \[Collection users\](/docs/developers/gitbook-api/api-reference/collections/collection-users.md): Handle permissions and user management for a specific collection. - \[Collection teams\](/docs/developers/gitbook-api/api-reference/collections/collection-teams.md): Allocate team-based permissions to your collections. - \[Spaces\](/docs/developers/gitbook-api/api-reference/spaces.md): Create, maintain, and remove content spaces. - \[Space content\](/docs/developers/gitbook-api/api-reference/spaces/space-content.md): Import, export, and search content in a space. - \[Space comments\](/docs/developers/gitbook-api/api-reference/spaces/space-comments.md): Integrate and manage user comments in a space. - \[Space embeds\](/docs/developers/gitbook-api/api-reference/spaces/space-embeds.md): Render or resolve embedded content within a space. - \[Space users\](/docs/developers/gitbook-api/api-reference/spaces/space-users.md): Manage user roles and permissions on a per-space basis. - \[Space teams\](/docs/developers/gitbook-api/api-reference/spaces/space-teams.md): Integrate team-based permissions for better collaboration in a space. - \[Space integrations\](/docs/developers/gitbook-api/api-reference/spaces/space-integrations.md): Connect external tools and plugins to enhance your space functionality. - \[Git\](/docs/developers/gitbook-api/api-reference/spaces/git.md): Connect Git repositories to your space for seamless version control. - \[Change requests\](/docs/developers/gitbook-api/api-reference/change-requests.md): Review and collaborate on proposed documentation changes before merging. - \[Change request content\](/docs/developers/gitbook-api/api-reference/change-requests/change-request-content.md): Manage the actual content changes associated with a change request. - \[Change request contributors\](/docs/developers/gitbook-api/api-reference/change-requests/change-request-contributors.md): See who's participating in the change request. - \[Change request reviewers\](/docs/developers/gitbook-api/api-reference/change-requests/change-request-reviewers.md): Assign or list requested reviewers for a change request. - \[Change request comments\](/docs/developers/gitbook-api/api-reference/change-requests/change-request-comments.md): Engage in threaded conversations on proposed changes. - \[Translations\](/docs/developers/gitbook-api/api-reference/translations.md): Configure multi-language support and translation options for your documentation. - \[Glossary\](/docs/developers/gitbook-api/api-reference/translations/glossary.md): Manage custom terms translations used by the translation feature. - \[Imports\](/docs/developers/gitbook-api/api-reference/imports.md): Import content into GitBook. - \[Integrations\](/docs/developers/gitbook-api/api-reference/integrations.md): Install and handle third-party integrations for extended GitBook functionality. - \[URLs\](/docs/developers/gitbook-api/api-reference/urls.md): Configure where and how your GitBook content can be accessed. - \[OpenAPI\](/docs/developers/gitbook-api/api-reference/openapi.md): Upload, access, or version-control your OpenAPI specifications directly in GitBook. - \[OpenAPI spec versions\](/docs/developers/gitbook-api/api-reference/openapi/openapi-spec-versions.md): Track changes to your OpenAPI documents by versioning them. - \[Conversations\](/docs/developers/gitbook-api/api-reference/conversations.md): Ingest knowledge for Conversations. - \[Custom fonts\](/docs/developers/gitbook-api/api-reference/custom-fonts.md): Bring your own fonts to personalize your documentation style. - \[Subdomains\](/docs/developers/gitbook-api/api-reference/subdomains.md): Manage and configure organization-specific subdomains for your docs. - \[Users\](/docs/developers/gitbook-api/api-reference/users.md): Retrieve and manage user information and profiles. - \[Teams\](/docs/developers/gitbook-api/api-reference/teams.md): Create and manage teams as reusable groups of users. - \[Team members\](/docs/developers/gitbook-api/api-reference/teams/team-members.md): Control membership at the team level for cohesive role management. - \[SSO\](/docs/developers/gitbook-api/api-reference/sso.md): Configure Single Sign-On solutions to unify your organization's authentication. - \[Storage\](/docs/developers/gitbook-api/api-reference/storage.md): Upload and store files directly within your GitBook organization. - \[Custom hostnames\](/docs/developers/gitbook-api/api-reference/custom-hostnames.md): Serve your GitBook content from fully branded, custom hostnames. - \[System info\](/docs/developers/gitbook-api/api-reference/system-info.md): Programmatically check GitBook API system status and version details. - \[Authentication\](/docs/developers/gitbook-api/authentication.md): Authenticate your user when using the GitBook API - \[Rate limiting\](/docs/developers/gitbook-api/rate-limiting.md) - \[Pagination\](/docs/developers/gitbook-api/pagination.md) - \[Errors\](/docs/developers/gitbook-api/errors.md) - \[Concepts\](/docs/developers/gitbook-api/concepts.md): Learn about different GitBook concepts related to the GitBook API - \[Guides\](/docs/developers/gitbook-api/guides.md) ## Guides - \[Welcome to GitBook guides\](/docs/guides/readme.md): Explore GitBook’s features in more detail, discover new ways to work, and learn documentation best practices with our expert guides - \[Editing & publishing documentation: In this section\](/docs/guides/editing-and-publishing-documentation/editing-and-publishing-documentation-in-this-section.md): Why GitBook is the ultimate platform for editing and publishing documentation - \[The complete guide to creating and publishing documentation in GitBook \\\[updated for 2025\\\]\](/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook.md): Learn how to use GitBook to create public or private documentation for your project — and how to add customizations, check analytics, and more - \[Import or migrate your content to GitBook with Git Sync\](/docs/guides/editing-and-publishing-documentation/import-or-migrate-your-content-to-gitbook-with-git-sync.md): Easily import content from your previous documentation provider — or from GitHub or GitLab — using Git Sync in GitBook - \[Import content from a CSV file into GitBook\](/docs/guides/editing-and-publishing-documentation/import-zendesk-csv-to-gitbook.md): Learn how to add data from Zendesk — or any other CSV file — into GitBook - \[How to handle merge conflicts in GitBook\](/docs/guides/editing-and-publishing-documentation/how-to-handle-merge-conflicts-in-gitbook.md): Why do merge conflicts happen in GitBook and how do you resolve them? Our guide can help. - \[Find & replace or make batch changes across your GitBook docs with Git Sync\](/docs/guides/editing-and-publishing-documentation/find-and-replace-or-make-batch-changes-across-your-gitbook-docs-with-git-sync.md): Sync your docs to GitHub or GitLab and make bulk changes to your docs with a single pull request - \[Upload and embed a playable video into your GitBook docs\](/docs/guides/editing-and-publishing-documentation/upload-and-embed-a-playable-video-into-your-gitbook-docs.md): Drag and drop a video from your desktop into GitBook, then set it up so users can play that video on the page - \[Content organization & localization: in this section\](/docs/guides/content-organization-and-localization/content-organization-and-localization-in-this-section.md): How GitBook helps you organize and localization your technical documentation with site sections and automatic translations that update when you change your primary-language content - \[Combine multiple existing sites into one using site sections\](/docs/guides/content-organization-and-localization/combine-multiple-docs-sites-using-sections.md): We run through the process of centralizing all your existing documentation in a single site using site sections in GitBook - \[Use GitHub Actions to translate GitBook pages\](/docs/guides/content-organization-and-localization/use-github-actions-to-translate-gitbook-pages.md) - \[Localize your docs with variants in GitBook\](/docs/guides/content-organization-and-localization/localize-your-docs-with-variants-in-gitbook.md): Learn how to use variants in GitBook to translate and manage different versions of your docs site for multiple languages - \[SEO & LLM optimization: in this section\](/docs/guides/seo-and-llm-optimization/seo-and-llm-optimization-in-this-section.md): How GitBook automatically optimizes your docs for SEO and LLM ingestion - \[GEO guide: How to optimize your docs for AI search and LLM ingestion\](/docs/guides/seo-and-llm-optimization/geo-guide-how-to-optimize-your-docs-for-ai-search-and-llm-ingestion.md): Learn how to optimize documentation for generative engine optimization (GEO), SEO, and LLM ingestion — all powered by GitBook’s AI-ready docs. - \[How to use SEO techniques to improve your documentation\](/docs/guides/seo-and-llm-optimization/how-to-use-seo-techniques-to-improve-your-documentation.md): Make it easier for your existing users or potential customers to find your docs with these simple tricks to help your content rank high in search engines - \[Docs workflow optimization: in this section\](/docs/guides/docs-workflow-optimization/docs-workflow-optimization-in-this-section.md): Discover how and why GitBook helps you optimize your docs workflow and build the best documentation for your users - \[Introducing AI into your product documentation workflow\](/docs/guides/docs-workflow-optimization/introducing-ai-into-your-product-documentation-workflow.md): Discover how you can use AI tools to improve your docs workflow — including its limitations and how to overcome them - \[Build your docs around your users’ needs with documentation personas\](/docs/guides/docs-workflow-optimization/documentation-personas.md): With documentation personas, you can focus on the challenges your users are facing, what they need to achieve, and how your docs can help them get there - \[7 ways to make your public documentation more useful for users\](/docs/guides/docs-workflow-optimization/7-ways-to-make-your-public-documentation-more-useful-for-users.md): Tips and advice to help you create great documentation, so you can improve your user ratings and reduce your support team’s load - \[Quick tips to improve your technical writing workflow in GitBook\](/docs/guides/docs-workflow-optimization/quick-tips-to-improve-your-technical-writing-workflow-in-gitbook.md): Shortcuts, tricks and advice to help you up your technical documentation game in GitBook and make your content work harder - \[API documentation: in this section\](/docs/guides/api-documentation/api-documentation-in-this-section.md): We explain how GitBook makes it easy to generate and maintain beautiful API docs using OpenAPI spec files, interactive API playgrounds, and extensive customization options - \[How to write incredible API documentation\](/docs/guides/api-documentation/how-to-write-incredible-api-documentation.md): What we’ve learned about writing API docs that drive adoption and reduce support. - \[Document your API in GitBook in 5 simple steps\](/docs/guides/api-documentation/document-your-api-in-gitbook-in-5-simple-steps.md): Learn how to build beautiful, interactive API documentation in GitBook. - \[API docs: The seven principles of great API docs and how to apply them\](/docs/guides/api-documentation/api-documentation-principles.md): Create great API documentation for your users using these foundational principles - \[Docs analytics: in this section\](/docs/guides/docs-analytics/docs-analytics-in-this-section.md): Explore how GitBook’s built-in insights and analytics integrations make it easy to measure docs success - \[Documentation analytics: which metrics to track and how to measure success\](/docs/guides/docs-analytics/documentation-analytics.md): Still figuring out the best way to prove success with your user-facing documentation? This guide will help you figure out what to track and how to analyze the data. - \[Track documentation analytics with Google Analytics\](/docs/guides/docs-analytics/track-documentation-analytics-with-google-analytics.md): Learn how to install and configure the Google Analytics integration so you can track detailed analytics from your docs site - \[Track advanced analytics with GitBook's Events Aggregation API\](/docs/guides/docs-analytics/track-advanced-analytics-with-gitbooks-events-aggregation-api.md): Master GitBook’s powerful events aggregation endpoint to create custom analytics dashboards, understand user behavior patterns, and make data-driven decisions about your documentation strategy. - \[Analyze change request contributors with GitBook’s API\](/docs/guides/docs-analytics/analyze-change-request-contributors-with-gitbooks-api.md): Track creators, reviewers, and contributors with GitBook’s API to understand how your team collaborates - \[Docs personalization & authentication: in this section\](/docs/guides/docs-personalization-and-authentication/docs-personalization-and-authentication-in-this-section.md): How to personalize docs for every user with GitBook’s built-in adaptive content tools - \[How to personalize your GitBook site using URL parameters and adaptive content\](/docs/guides/docs-personalization-and-authentication/how-to-personalize-your-gitbook-site-using-url-parameters-and-adaptive-content.md) - \[How to personalize your GitBook site using cookies and adaptive content\](/docs/guides/docs-personalization-and-authentication/setting-up-adaptive-content.md): Learn how to set up adaptive content so you can tailor your docs to individual readers based on user data or URL parameters - \[How to personalize your GitBook site using Auth0 and adaptive content\](/docs/guides/docs-personalization-and-authentication/how-to-personalize-your-gitbook-site-using-auth0-and-adaptive-content.md) - \[Docs best practices: in this section\](/docs/guides/docs-best-practices/docs-best-practices-in-this-section.md): Get advice on how to improve your documentation, and explore how GitBook encourages documentation best practices for your entire team - \[How to create branded documentation\](/docs/guides/docs-best-practices/how-to-create-branded-documentation.md): Make your docs match your brand with a custom domain, logo, color scheme and more - \[How to structure technical documentation: best practices\](/docs/guides/docs-best-practices/documentation-structure-tips.md): Whether you’re creating API docs, product docs, FAQs, technical guides, onboarding docs or a mixture of them all, here’s how you build a structure that makes them easy for customers to use - \[Make your documentation process more collaborative with change requests\](/docs/guides/docs-best-practices/make-your-documentation-process-more-collaborative-with-change-requests.md): Change requests in GitBook make it easier for your whole team contribute to the documentation process — whether they’re editing pages, reviewing changes, or just leaving feedback - \[How to encourage contributions to your open source documentation\](/docs/guides/docs-best-practices/how-to-encourage-contributions-to-your-open-source-documentation.md): 7 things you can do to make it easier for contributors to write docs for your OSS project ## Changelog - \[Better code syntax highlighting, custom links for your site logo and more\](/docs/changelog/november-2025/better-code-syntax-highlighting-custom-links-for-your-site-logo-and-more.md): 18 November: With this release, we’ve added Shiki syntax highlighting for code blocks, added a customizable link for your site logo, a new block switching menu, and more - \[Embed GitBook Assistant, performance improvements and more\](/docs/changelog/november-2025/embed-gitbook-assistant-performance-improvements-and-more.md): 11 November: With this release you can now embed GitBook Assistant in your product or website — plus we’ve made performance improvements, added new cover resizing options and more - \[Search result breadcrumbs, better variant + language support and more\](/docs/changelog/november-2025/search-result-breadcrumbs-better-variant-+-language-support-and-more.md): 4 November: Breadcrumbs in search results, better support for languages and versions on the same docs site, a new comments popover panel and plenty of other improvements and bug fixes - \[Improvements to change requests, site search, version history and more\](/docs/changelog/october-2025/improvements-to-change-requests-site-search-version-history-and-more.md): 28 October: Improved sidebars for change requests and version history, plus search improvements, expandable code blocks and more - \[New keyboard shortcuts, block duplication, colored inline icons and more\](/docs/changelog/october-2025/new-keyboard-shortcuts-block-duplication-colored-inline-icons-and-more.md): 16 October: Quickly switch between paragraphs and headings, duplicate blocks with a tap, add colored icons to your page and more - \[Better migration support, improved search and more\](/docs/changelog/october-2025/better-migration-support-improved-search-and-more.md): 7 October: Migration and import improvements, searchable reusable content & API specs, and a bunch of other improvements and bug fixes - \[24 September: Nested section groups, new change request review options and more\](/docs/changelog/september-2025/24-september-nested-section-groups-new-change-request-review-options-and-more.md): We’ve added nested group support for site sections, allowing you to create hierarchical navigation — plus a few other improvements and fixes - \[16 September: MCP docs server generator, new search controls & more\](/docs/changelog/september-2025/16-september-mcp-docs-server-generator-new-search-controls-and-more.md): You can now MCP servers so AI tools can interact with your docs, plus we’ve added new controls for users searching your docs, improved the page outline, and more - \[9 September: Merge rules, improved language selection and more\](/docs/changelog/september-2025/9-september-merge-rules-improved-language-selection-and-more.md): New ways to control when change requests are merged and by whom, plus improvements to localization support, change requests and more - \[19 August: Auto-updating translations, AI Assistant improvements and more\](/docs/changelog/august-2025/19-august-auto-updating-translations-ai-assistant-improvements-and-more.md): Introducing an all-new, super simple way to localize your docs and maintain the translations — plus smaller improvements to Assistant, better LLM-ready docs and more - \[1 August: GitBook Assistant, improved insights, new AI actions and more\](/docs/changelog/august-2025/1-august-gitbook-assistant-improved-insights-new-ai-actions-and-more.md): This release introduces a supercharged new AI assistant, improved insights options, a new wider page width option that’s perfect for building landing pages, and much more - \[15 July: Variables, redesigned search, better diff view and more\](/docs/changelog/july-2025/15-july-variables-redesigned-search-better-diff-view-and-more.md): Create and add reusable variables to your docs, plus a redesigned search experience for your published docs, and other editor improvements - \[8 July: Custom code fonts, make your API spec public and more\](/docs/changelog/july-2025/8-july-custom-code-fonts-make-your-api-spec-public-and-more.md): You can now upload your own custom font for code blocks, create new sites more easily, make your API spec public and more - \[24 June: Performance upgrades, llms-full.txt and .md support, text alignment and more\](/docs/changelog/june-2025/24-june-performance-upgrades-llms-full.txt-and-.md-support-text-alignment-and-more.md): Your docs sites load faster and support llms-full.txt and .md for LLM ingestion — plus you can now add icons to buttons, center- or right-align text on the page, and much more - \[17 June: Column blocks, inline icons and a bunch of smaller improvements\](/docs/changelog/june-2025/17-june-column-blocks-inline-icons-and-a-bunch-of-smaller-improvements.md): We’ve added a new block type — columns — plus inline icons, a better site structure management experience and more - \[10 June: New customization styles, email improvements, dark mode cover images and more\](/docs/changelog/june-2025/10-june-new-customization-styles-email-improvements-dark-mode-cover-images-and-more.md): You can now add circular buttons, choose flatter design elements, and select cover images specifically for light and dark mode in GitBook - \[20 May: Commenting improvements, link UI improvements, a new dashboard and more\](/docs/changelog/may-2025/20-may-commenting-improvements-link-ui-improvements-a-new-dashboard-and-more.md): We’ve made comments easier to read and use, tweaked the UX for adding and editing links, fixed some bugs and made other smaller improvements - \[13 May: Global reusable content and an all-new sidebar design\](/docs/changelog/may-2025/readme.md): You can now create reusable content and add it anywhere in your organization — plus some major sidebar improvements, bug fixes and more - \[6 May: Add inline buttons to your docs, easy block selection and more\](/docs/changelog/may-2025/6-may-add-inline-buttons-to-your-docs-easy-block-selection-and-more.md): Want to add a button to your published docs? Now you can — plus we’ve made block selection easier, and made some smaller improvements and fixes - \[30 April: Auto-updating API reference docs, design improvements, editor updates and more\](/docs/changelog/april-2025/30-april-auto-updating-api-reference-docs-design-improvements-editor-updates-and-more.md): There’s a new home for your OpenAPI specification that makes generating and updating API reference docs effortless, plus a bunch of other improvements. - \[8 April: Link tooltips, even more editor improvements, and some bug fixes\](/docs/changelog/april-2025/8-april-link-tooltips-even-more-editor-improvements-and-some-bug-fixes.md): Work continues on giving you the best editor experience possible, and we’ve added new tooltips to links in published docs to give readers extra context before they click - \[1 April: New and improved tables, announcement banners, custom fonts and more\](/docs/changelog/april-2025/1-april-new-and-improved-tables-announcement-banners-custom-fonts-and-more.md): Huge table improvements and custom fonts for published sites lead the way this week — which also marks GitBook’s 11th birthday! 🎉 - \[25 March: A ton of editor improvements, bug fixes and more\](/docs/changelog/march-2025/25-march-a-ton-of-editor-improvements-bug-fixes-and-more.md): A dedicated team have been working hard on making some editor improvements and fixes to improve the overall editing experience in GitBook - \[18 March: A new search bar style, better link editing, plus small improvements and fixes\](/docs/changelog/march-2025/18-march-a-new-search-bar-style-better-link-editing-plus-small-improvements-and-fixes.md): We’ve added a new way to display your search bar, made it easier to edit or copy links in the editor, and made a big bunch of other improvements and fixes - \[4 March: New link styles, broken URL insights, a new integration and more\](/docs/changelog/march-2025/4-march-new-link-styles-broken-url-insights-a-new-integration-and-more.md): We’ve added a new customization option, a new way to view external links pointing to nonexistent pages in your docs so you can fix them, and a bunch of smaller improvements and fixes - \[25 February: New and improved hint blocks\](/docs/changelog/february-2025/25-february-new-and-improved-hint-blocks.md): You can now add titles to hint blocks and customize their colors for published content, plus we’ve released a number of other smaller improvements - \[19 February: Powerful new themes, site section groups and more\](/docs/changelog/february-2025/19-february-powerful-new-themes-site-section-groups-and-more.md): We’ve added some incredible new customization options for your docs site, including new theming options and site section groups that let you create a nav with drop-down menus - \[11 February: An all-new preview, better OpenAPI blocks and more\](/docs/changelog/february-2025/11-february-an-all-new-preview-better-openapi-blocks-and-more.md): We’ve given your site preview a big upgrade with extra options, improved our OpenAPI blocks, added some new integrations, and more - \[4 February: Completely revamped insights, a better header bar and more\](/docs/changelog/february-2025/4-february-completely-revamped-insights-a-better-header-bar-and-more.md): We just shipped a huge improvement to your site insights, along with a new header bar to make space and site management easier - \[28 January: /llms.txt support, improved sitemapping and more\](/docs/changelog/january-2025/28-january-llms.txt-support-improved-sitemapping-and-more.md): All GitBook sites now automatically generate an /llms.txt file to make it easier for large language models to process your site data - \[21 January: A better site footer, clearer cards, keyboard formatting and more\](/docs/changelog/january-2025/21-january-a-better-site-footer-clearer-cards-keyboard-formatting-and-more.md): This week we’ve made visual improvements to your site’s footer, added placeholders to empty card fields, add keyboard formatting options, and more - \[14 January: A big upgrade for docs site TOCs, plus better tables and emojis\](/docs/changelog/january-2025/14-january-a-big-upgrade-for-docs-site-tocs-plus-better-tables-and-emojis.md): We’ve added more customization options for the table of contents, plus a new alignment setting for tables and an emoji update in the GitBook app - \[7 January: Ask AI insights, TOC improvements, an emoji update and more\](/docs/changelog/january-2025/7-january-ask-ai-insights-toc-improvements-an-emoji-update-and-more.md): You can now see insights into what your users are asking in your docs, we’ve made some small improvements to the table of contents, and fixed a few bugs - \[17 December: Visual upgrades, table improvements and more\](/docs/changelog/december-2024/17-december-visual-upgrades-table-improvements-and-more.md): We’ve made some visual upgrades to published docs sites, added content breadcrumbs, made tables more consistent, and added new ways to style text in comments - \[10 December: Ask AI improvements, a better inline code experience and more\](/docs/changelog/december-2024/10-december-ask-ai-improvements-a-better-inline-code-experience-and-more.md): With this release your users can now get AI-powered answers from across all the sections of your docs site, plus we’ve improved inline code blocks, upgraded the page outline, and more - \[27 November: Site redirects, better site structure controls and more\](/docs/changelog/november-2024/27-nov-site-redirects-structure-and-more.md): Get more control over URLs, manage your site’s structure more easily, install integrations more easily, and auto-play and loop embedded videos in your docs effortlessly - \[25 October: Site sections with global search, sponsored docs for open source and more\](/docs/changelog/october-2024/25-october-site-sections-with-global-search-sponsored-docs-for-open-source-and-more.md): Make your docs a content hub with site sections, create and reuse content across a space, add buttons to your site header, use stepper blocks in your content, and even more… - \[1 October: Improved diff view, synced blocks and more\](/docs/changelog/october-2024/1-october-improved-diff-view-synced-blocks-and-more.md): We’re adding reusable content to GitBook, along with a better way to view edits in a change request, improved change request previews, and more. - \[Announcement: URLs for multi-variant docs sites are changing\](/docs/changelog/september-2024/announcement-urls-for-multi-variant-docs-sites-are-changing.md): 24 September — We’re changing the structure of URLs for sites with multiple variants — and we’ve set up automatic redirects to ensure all links still work as expected - \[17 September: Page index controls, better OpenAPI blocks and more\](/docs/changelog/september-2024/17-september-page-index-controls-better-openapi-blocks-and-more.md): You can now exclude specific pages from searching indexing — for both in-app search and external search engines - \[27 August: A new space header, bug fixes, and a bunch of smaller improvements\](/docs/changelog/august-2024/27-august-a-new-space-header-bug-fixes-and-a-bunch-of-smaller-improvements.md): We’ve just released a new space header to make it easier to manage your content, plus a whole host of other smaller changes to improve your experience in GitBook. - \[8 August: Page icons, docs site improvements, hidden pages and more\](/docs/changelog/august-2024/8-august-page-icons-docs-site-improvements-hidden-pages-and-more.md): We’ve added new icon options for your pages, made a bunch of improvements to docs sites, made hidden pages and MFA available for everyone, and much more - \[5 August: Docs sites rollout introduces new publishing flow in the GitBook API\](/docs/changelog/august-2024/5-august-docs-sites-rollout-introduces-new-publishing-flow-in-the-gitbook-api.md): With the introduction of docs sites, several older API endpoints for publishing, share-links, and authenticated access have been deprecated - \[18 July: Rolling out MFA and the hidden pages beta\](/docs/changelog/july-2024/18-july-rolling-out-mfa-and-the-hidden-pages-beta.md): This release lets you make your account more secure, adds a beta option to hide pages from published sites, and includes a bunch of other, smaller improvements - \[1 July: New localizations, docs site improvements and more\](/docs/changelog/july-2024/1-july-new-localizations-docs-site-improvements-and-more.md): Support for Brazilian Portuguese and German, a new way to manage and install integrations, and a whole bunch of docs site improvements - \[31 May: Introducing docs sites, the new way to publish content in GitBook\](/docs/changelog/may-2024/31-may-introducing-docs-sites-the-new-way-to-publish-content-in-gitbook.md): We’ve revamped the way you publish content in GitBook by bringing all your published content together, along with all the settings and features related to publishing. - \[22 May: GitBook AI gets a GPT-4o upgrade and new diagramming skills\](/docs/changelog/may-2024/22-may-gitbook-ai-gets-a-gpt-4o-upgrade-and-new-diagramming-skills.md): We’ve migrated our AI to use the latest model, so asking questions and generating content will have even better results — plus we’ve added AI diagrams to our drawing tool - \[30 April: Broken link detection and GitBook AI comes out of beta\](/docs/changelog/april-2024/30-april-broken-link-detection-and-gitbook-ai-comes-out-of-beta.md): Broken link detection for internal links, AI features are officially graduating, plus some other small but useful updates and bug fixes throughout the app - \[19 April: Small improvements and bug fixes\](/docs/changelog/april-2024/19-april-small-improvements-and-bug-fixes.md): We’ve made some small but useful improvements to the app, and squashed some pesky bugs as we prep for a bigger release coming soon. - \[27 March: Open-sourcing our published documentation\](/docs/changelog/march-2024/27-march-open-sourcing-our-published-documentation.md): You can now contribute and suggest improvements to GitBook to make published documentation even better - \[4 March: Huge improvements to your published documentation\](/docs/changelog/march-2024/4-march-huge-improvements-to-your-published-documentation.md): Your published sites are getting a big update, with a new look, better performance, extra customization, improved OpenAPI blocks, a redesigned PDF experience and more - \[21 February: Edit text with AI, a published docs preview and more\](/docs/changelog/february-2024/21-february-edit-text-with-ai-a-published-docs-preview-and-more.md): We’ve added the option to edit text with AI, a preview of our new published documentation experience, and a bunch of other nice improvements - \[8 February 2024: Deprecating the API method block in favor of OpenAPI improvements\](/docs/changelog/february-2024/depreciating-api-method-block.md): We’re making big improvements to our OpenAPI support and API documentation rendering — so we’re replacing the editable API method block with a standard text alternative. - \[2 February: AI writing assistant, a new home for important updates, and more!\](/docs/changelog/february-2024/1-february-ai-writing-and-more.md): We’ve added new ways to create and edit text with AI, plus a new Home section, snippet improvements, and a bunch of bug fixes - \[22 January: Small improvements and bug fixes\](/docs/changelog/january-2024/22-january-small-improvements-and-bug-fixes.md): We’ve shipped some small but useful improvements to the app, and squashed some pesky bugs - \[10 January: Turn snippets into docs, change your public docs font and more\](/docs/changelog/january-2024/10-january-turn-snippets-into-docs-change-your-public-docs-font-and-more.md): We’re making it even easier to turn knowledge into documentation in your knowledge base, adding a free customization option for everyone, and much more - \[30 November: A huge update for GitBook\](/docs/changelog/november-2023/30-november-a-huge-update-for-gitbook.md): New integrations, a more modern design, better performance, and new features to help you audit and improve your content - \[16 November: Feedback scoring overhaul in the API\](/docs/changelog/november-2023/16-november-feedback-scoring-overhaul-in-the-api.md): We’ve revised how feedback scores are calculated in the Insights API - \[13 November: Side panel and sidebar improvements\](/docs/changelog/november-2023/13-november-side-panel-and-sidebar-improvements.md): We’ve made getting information about your space more consistent, and improved the sidebar to make it easier to browse and copy your content - \[5 October: Theme-aware images, team owners and more\](/docs/changelog/october-2023/5-october-theme-aware-images-team-owners-and-more.md): We’ve added an option to tailor images for light and dark modes, added team owners, and have some great security news to share! - \[27 September: Real-time collaboration and reviews\](/docs/changelog/september-2023/27-september-real-time-collaboration-and-reviews.md): We’ve made collaboration better than ever with real-time editing and reviews for change requests - \[22 August: Member management and more\](/docs/changelog/august-2023/22-august-member-management-and-more.md): We’ve made it easier to manage members in your organization, plus made some other useful improvements - \[24 July: Iterating, improving, fixing\](/docs/changelog/july-2023/24-july-iterating-improving-fixing.md): We’ve made some small (but mighty) quality-of-life improvements with our latest releases - \[29 June: More customization options and our new integrations platform\](/docs/changelog/june-2023/29-june-more-customization-options-and-our-new-integrations-platform.md): Powerful page options give you more control, plus we have a new platform so you can build your own integrations for GitBook! - \[30 May: A light/dark mode toggle and new customization options\](/docs/changelog/may-2023/30-may-a-light-dark-mode-toggle-and-new-customization-options.md): We’ve added a light and dark mode toggle for your public documentation, and new color settings to help you customize your content - \[27 April 23: Image resizing and othe improvements\](/docs/changelog/april-2023/27-april-23-image-resizing-and-othe-improvements.md): We’ve improved the editor to give you more options when it comes to image sizes - \[7 April 23: Block selection and upcoming improvements to the GitBook editor\](/docs/changelog/april-2023/7-april-23-block-selection-and-upcoming-improvements-to-the-gitbook-editor.md): We're opening a series of improvements to our editor by enabling block selection and interactions on selected blocks. - \[5 April 23: GitBook AI search, preview your change requests and more\](/docs/changelog/april-2023/5-april-23-gitbook-ai-and-lens-preview-your-change-requests-and-more.md) - \[24 February 23: AI-powered search, share & permissions, and more\](/docs/changelog/february-2023/24-february-23-smart-search-share-and-permissions-and-more.md): A new search feature powered by AI and a number of quality-of-life improvements on GitBook - \[07 February 23: Monorepos, customized commit messages, and more\](/docs/changelog/february-2023/07-february-23-monorepos-customized-commit-messages-and-more.md): More flexibility with Git Sync and some new designs for search and change requests. - \[31 January 23: Change request subject, ordered lists, and more\](/docs/changelog/january-2023/31-january-23-change-request-subject-ordered-lists-and-more.md): We've added more context around change requests, improved performance and squashed some bugs. - \[24 January 23: New comments UI, improved diff view, and more\](/docs/changelog/january-2023/24-january-23-new-comments-ui-improved-diff-view-and-more.md): We've spent a lot of time fixing critical bugs, improving performance, and adding key features. - \[15 December 22: Editor improvements, and more\](/docs/changelog/december-2022/15-december-22-editor-improvements-and-more.md): We've worked on GitBook's overall editor experience, improving reliability, copy/paste from multiple sources and speedy shortcuts. - \[30 November 22: Annotations, footnotes, and more\](/docs/changelog/november-2022/30-november-22-annotations-footnotes-and-more.md): We’ve added more ways to provide contextual information for your visitors, as well as improvements to expandable blocks and several bug fixes. - \[22 November 22: Linking pages from another space, and more\](/docs/changelog/november-2022/22-november-22-linking-pages-from-another-space-and-more.md) - \[3 November 22: Public docs, integrations, and more\](/docs/changelog/november-2022/3-november-22-public-docs-integrations-and-more.md) - \[6 September: Introducing organization management endpoints for the GitBook API\](/docs/changelog/september-2022/6-september-introducing-organization-management-endpoints-for-the-gitbook-api.md): A new API collection is now available for managing members, invites, and teams at scale - \[12 August 22: Auto-sizing columns, and more\](/docs/changelog/august-2022/12-august-22-auto-sizing-columns-and-more.md) - \[4 August 22: Code blocks, invites, and more\](/docs/changelog/august-2022/4-august-22-code-blocks-invites-and-more.md) - \[26 July 22: New Git Sync, and more\](/docs/changelog/july-2022/26-july-22-new-git-sync-and-more.md) - \[18 July 22: Slack and Segment integration, notifications, and more\](/docs/changelog/july-2022/18-july-22-slack-and-segment-integration-notifications-and-more.md) - \[30 June: Multiple breaking changes to ownership, paths & change-requests in the GitBook API\](/docs/changelog/june-2022/30-june-multiple-breaking-changes-to-ownership-paths-and-change-requests-in-the-gitbook-api.md): We’ve removed the /v1/owners/:id/spaces endpoint in favor of more explicit replacements - \[Introducing GitBook 3.0\](/docs/changelog/past-releases/introducing-gitbook-3.0.md): Hot off the press, it's GitBook's new releases - \[Expandable Blocks\](/docs/changelog/past-releases/expandable-blocks.md): Better-structure your content with an expand/collapse pattern. - \[Cover Images\](/docs/changelog/past-releases/cover-images.md): Give your pages a bit more life with cover images - \[Faster Change Request Merges\](/docs/changelog/past-releases/faster-change-request-merges.md): Skip review processes and quickly merge your content. ## Help Center - \[Help Center\](/docs/help-center/readme.md): Get help and guidance from detailed FAQs written by GitBook’s support team, or ask GitBook Assistant about specific topics - \[Managing your organization\](/docs/help-center/account-management/managing-your-organization.md) - \[How do I transfer the ownership of an organization to another email/person?\](/docs/help-center/account-management/managing-your-organization/how-do-i-transfer-the-ownership-of-an-organization-to-another-email-person.md): How to transfer ownership of an organization. - \[How can I remove organization members?\](/docs/help-center/account-management/managing-your-organization/how-can-i-remove-organization-members.md) - \[How do I transfer an organization to a different account?\](/docs/help-center/account-management/managing-your-organization/how-do-i-transfer-an-organization-to-a-different-account.md) - \[What happens to my content if an account or organization is deleted?\](/docs/help-center/account-management/managing-your-organization/what-happens-to-my-content-if-an-account-or-organization-is-deleted.md) - \[Error: SignatureDoesNotMatch -SAML SSO\](/docs/help-center/account-management/managing-your-organization/error-signaturedoesnotmatch-saml-sso.md) - \[Managing your account\](/docs/help-center/account-management/managing-your-account.md) - \[Why I am not receiving emails from GitBook?\](/docs/help-center/account-management/managing-your-account/why-i-am-not-receiving-emails-from-gitbook.md) - \[Why I am not receiving notifications?\](/docs/help-center/account-management/managing-your-account/why-i-am-not-receiving-notifications.md) - \[Why has my account been disabled by administrator?\](/docs/help-center/account-management/managing-your-account/why-has-my-account-been-disabled-by-administrator.md) - \[Why am I getting: Error: auth/invalid-email\](/docs/help-center/account-management/managing-your-account/why-am-i-getting-error-auth-invalid-email.md) - \[Error: auth/email-already-in-use\](/docs/help-center/account-management/managing-your-account/error-auth-email-already-in-use.md) - \[Error: auth/expired-action-code\](/docs/help-center/account-management/managing-your-account/error-auth-expired-action-code.md) - \[Subscriptions\](/docs/help-center/account-management/subscriptions.md) - \[What does GitBook’s trial include?\](/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include.md) - \[If I subscribe to a paid plan, can I remove the "Powered by GitBook" badge?\](/docs/help-center/account-management/subscriptions/if-i-subscribe-to-a-paid-plan-can-i-remove-the-powered-by-gitbook-badge.md) - \[How can I apply for a Community plan?\](/docs/help-center/account-management/subscriptions/how-can-i-apply-for-a-community-plan.md) - \[Do I have to pay to publish a site?\](/docs/help-center/account-management/subscriptions/do-i-have-to-pay-to-publish-a-site.md) - \[Are guests or readers free members?\](/docs/help-center/account-management/subscriptions/are-guests-or-readers-free-members.md) - \[Does GitBook offer a free plan for non-profit/open-source organizations?\](/docs/help-center/account-management/subscriptions/does-gitbook-offer-a-free-plan-for-non-profit-open-source-organizations.md) - \[When will I be charged for inviting a new member to my organization?\](/docs/help-center/account-management/subscriptions/when-will-i-be-charged-for-inviting-a-new-member-to-my-organization.md) - \[Billing and payments\](/docs/help-center/account-management/billing-and-payments.md) - \[How can I transfer billing and invoice management to another team member?\](/docs/help-center/account-management/billing-and-payments/how-can-i-transfer-billing-and-invoice-management-to-another-team-member.md) - \[Where can I find my invoices, and how do I update billing details?\](/docs/help-center/account-management/billing-and-payments/where-can-i-find-my-invoices-and-how-do-i-update-billing-details.md) - \[What payment methods do you accept?\](/docs/help-center/account-management/billing-and-payments/what-payment-methods-do-you-accept.md) - \[Can I change my billing method to invoicing?\](/docs/help-center/account-management/billing-and-payments/can-i-change-my-billing-method-to-invoicing.md) - \[I have paid for the yearly plan. Why did I receive another invoice?\](/docs/help-center/account-management/billing-and-payments/i-have-paid-for-the-yearly-plan.-why-did-i-receive-another-invoice.md) - \[Where can I find my receipts or invoices?\](/docs/help-center/account-management/billing-and-payments/where-can-i-find-my-receipts-or-invoices.md) - \[How can I make sure my company info is included on my receipts?\](/docs/help-center/account-management/billing-and-payments/how-can-i-make-sure-my-company-info-is-included-on-my-receipts.md) - \[Can I receive my receipts via email?\](/docs/help-center/account-management/billing-and-payments/can-i-receive-my-receipts-via-email.md) - \[When I invite a new member to my GitBook organization, when will I be charged?\](/docs/help-center/account-management/billing-and-payments/when-i-invite-a-new-member-to-my-gitbook-organization-when-will-i-be-charged.md) - \[Do you offer any discounts?\](/docs/help-center/account-management/billing-and-payments/do-you-offer-any-discounts.md) - \[Can I get a refund?\](/docs/help-center/account-management/billing-and-payments/can-i-get-a-refund.md) - \[Why Was I Charged for an Unexpected Plan Upgrade?\](/docs/help-center/account-management/billing-and-payments/why-was-i-charged-for-an-unexpected-plan-upgrade.md) - \[Writing and editing\](/docs/help-center/editing-content/writing-and-editing.md) - \[Can I edit GitBook on a smartphone?\](/docs/help-center/editing-content/writing-and-editing/can-i-edit-gitbook-on-a-smartphone.md) - \[Which blocks can be added inside an expandable block?\](/docs/help-center/editing-content/writing-and-editing/which-blocks-can-be-added-inside-an-expandable-block.md) - \[Does GitBook support RTL?\](/docs/help-center/editing-content/writing-and-editing/does-gitbook-support-rtl.md) - \[Does GitBook have a find and replace feature?\](/docs/help-center/editing-content/writing-and-editing/does-gitbook-have-a-find-and-replace-feature.md) - \[Why can't I see an option to approve a review request?\](/docs/help-center/editing-content/writing-and-editing/why-cant-i-see-an-option-to-approve-a-review-request.md) - \[Managing your content\](/docs/help-center/editing-content/managing-your-content.md) - \[How can I export my content?\](/docs/help-center/editing-content/managing-your-content/how-can-i-export-my-content.md) - \[Can I move a page between spaces?\](/docs/help-center/editing-content/managing-your-content/can-i-move-a-page-between-spaces.md) - \[Can I move a space between organizations?\](/docs/help-center/editing-content/managing-your-content/can-i-move-a-space-between-organizations.md) - \[Is there a limit on the documentation import size or number?\](/docs/help-center/editing-content/managing-your-content/is-there-a-limit-on-the-documentation-import-size-or-number.md) - \[Assets and files\](/docs/help-center/editing-content/assets-and-files.md) - \[Is there a storage limit for asset uploads?\](/docs/help-center/editing-content/assets-and-files/is-there-a-storage-limit-for-asset-uploads.md) - \[Does Gitbook Support MP4 files?\](/docs/help-center/editing-content/assets-and-files/does-gitbook-support-mp4-files.md) - \[Can I embed an iframe in GitBook?\](/docs/help-center/editing-content/assets-and-files/can-i-embed-an-iframe-in-gitbook.md) - \[What’s the recommended page cover image size?\](/docs/help-center/editing-content/assets-and-files/whats-the-recommended-page-cover-image-size.md) - \[Why is my image not loading?\](/docs/help-center/editing-content/assets-and-files/why-is-my-image-not-loading.md) - \[Custom domains\](/docs/help-center/published-documentation/custom-domains.md) - \[My custom subdomain isn't working. How do I troubleshoot DNS issues?\](/docs/help-center/published-documentation/custom-domains/my-custom-subdomain-isnt-working.-how-do-i-troubleshoot-dns-issues.md): A quick guide on how to troubleshoot dns issues in GitBook - \[How do I change or update my custom domain in GitBook?\](/docs/help-center/published-documentation/custom-domains/how-do-i-change-or-update-my-custom-domain-in-gitbook.md): This is a quick guide on how to change or update your custom domain in GitBook - \[How can I add a custom domain to a docs site?\](/docs/help-center/published-documentation/custom-domains/how-can-i-add-a-custom-domain-to-a-docs-site.md) - \[How can I change the slug in the URL?\](/docs/help-center/published-documentation/custom-domains/how-can-i-change-the-slug-in-the-url.md) - \[How can I solve the "path is already taken" error?\](/docs/help-center/published-documentation/custom-domains/how-can-i-solve-the-path-is-already-taken-error.md) - \[Publishing\](/docs/help-center/published-documentation/publishing.md) - \[How to unpublish a site?\](/docs/help-center/published-documentation/publishing/how-to-unpublish-a-site.md) - \[How can I publish a space?\](/docs/help-center/published-documentation/publishing/how-can-i-publish-a-space.md) - \[How to preview a docs site?\](/docs/help-center/published-documentation/publishing/how-to-preview-a-docs-site.md) - \[What happens to my site when I delete a space connected to it?\](/docs/help-center/published-documentation/publishing/what-happens-to-my-site-when-i-delete-a-space-connected-to-it.md) - \[Why is my space still indexed in search engines after I unpublished it?\](/docs/help-center/published-documentation/publishing/why-is-my-space-still-indexed-in-search-engines-after-i-unpublished-it.md) - \[How does GitBook handle SEO?\](/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo.md) - \[What is a default space and how to change it?\](/docs/help-center/published-documentation/publishing/what-is-a-default-space-and-how-to-change-it.md) - \[How can I publish a site with multiple versions?\](/docs/help-center/published-documentation/publishing/how-can-i-publish-a-site-with-multiple-versions.md) - \[What's the difference between a space and a docs site?\](/docs/help-center/published-documentation/publishing/whats-the-difference-between-a-space-and-a-docs-site.md) - \[How can I access insights or analytics?\](/docs/help-center/published-documentation/publishing/how-can-i-access-insights-or-analytics.md) - \[Customization\](/docs/help-center/published-documentation/customization.md) - \[Can I edit HTML, CSS, JS, or other custom code on GitBook?\](/docs/help-center/published-documentation/customization/can-i-edit-html-css-js-or-other-custom-code-on-gitbook.md) - \[How do I change or replace the favicon for my docs site?\](/docs/help-center/published-documentation/customization/how-do-i-change-or-replace-the-favicon-for-my-docs-site.md) - \[Site Insights\](/docs/help-center/published-documentation/site-insights.md) - \[Why is my Site insights data not loading?\](/docs/help-center/published-documentation/site-insights/why-is-my-site-insights-data-not-loading.md) - \[What does “Page not found” mean in insights?\](/docs/help-center/published-documentation/site-insights/what-does-page-not-found-mean-in-insights.md) - \[What does "Not set" means in referrer insights?\](/docs/help-center/published-documentation/site-insights/what-does-not-set-means-in-referrer-insights.md): Learn more about insights referrers - \[Adaptive content\](/docs/help-center/published-documentation/adaptive-content.md) - \[Which authentication method should I use for Adaptive content?\](/docs/help-center/published-documentation/adaptive-content/which-authentication-method-should-i-use-for-adaptive-content.md) - \[Can I have a partially public site with some authenticated content using Adaptive content?\](/docs/help-center/published-documentation/adaptive-content/can-i-have-a-partially-public-site-with-some-authenticated-content-using-adaptive-content.md) - \[Why aren’t my Adaptive Content segments working or showing in preview?\](/docs/help-center/published-documentation/adaptive-content/why-arent-my-adaptive-content-segments-working-or-showing-in-preview.md) - \[How do I set up Adaptive content with my custom OIDC provider?\](/docs/help-center/published-documentation/adaptive-content/how-do-i-set-up-adaptive-content-with-my-custom-oidc-provider.md) - \[FAQs\](/docs/help-center/published-documentation/adaptive-content/faqs.md) - \[Building and installing integrations\](/docs/help-center/integrations/building-and-installing-integrations.md) - \[Can I request an integration?\](/docs/help-center/integrations/building-and-installing-integrations/can-i-request-an-integration.md) - \[Does GitBook have a CLI tool?\](/docs/help-center/integrations/building-and-installing-integrations/does-gitbook-have-a-cli-tool.md) - \[Where can I install an integration?\](/docs/help-center/integrations/building-and-installing-integrations/where-can-i-install-an-integration.md) - \[How do I install an integration on my site?\](/docs/help-center/integrations/building-and-installing-integrations/how-do-i-install-an-integration-on-my-site.md) - \[Can I build my own integration?\](/docs/help-center/integrations/building-and-installing-integrations/can-i-build-my-own-integration.md) - \[Existing integrations\](/docs/help-center/integrations/existing-integrations.md) - \[Git Sync\](/docs/help-center/integrations/existing-integrations/git-sync.md) - \[Git Sync status shows an unexpected error\](/docs/help-center/integrations/existing-integrations/git-sync/git-sync-status-shows-an-unexpected-error.md) - \[​GitBook is not using my docs folder\](/docs/help-center/integrations/existing-integrations/git-sync/gitbook-is-not-using-my-docs-folder.md) - \[GitBook is creating new markdown files\](/docs/help-center/integrations/existing-integrations/git-sync/gitbook-is-creating-new-markdown-files.md) - \[​Nothing happens on GitBook after adding a new file to my repository\](/docs/help-center/integrations/existing-integrations/git-sync/nothing-happens-on-gitbook-after-adding-a-new-file-to-my-repository.md) - \[My table of contents is not correctly structured\](/docs/help-center/integrations/existing-integrations/git-sync/my-table-of-contents-is-not-correctly-structured.md) - \[Error when pushing to the repository with protected branch\](/docs/help-center/integrations/existing-integrations/git-sync/error-when-pushing-to-the-repository-with-protected-branch.md) - \[Git Sync file size limitations\](/docs/help-center/integrations/existing-integrations/git-sync/git-sync-file-size-limitations.md) - \[Why am I getting a Git authentication failed message?\](/docs/help-center/integrations/existing-integrations/git-sync/why-am-i-getting-a-git-authentication-failed-message.md) - \[Does Git Sync also sync pull-requests?\](/docs/help-center/integrations/existing-integrations/git-sync/does-git-sync-also-sync-pull-requests.md) - \[Why is the Mermaid block not loading?\](/docs/help-center/integrations/existing-integrations/why-is-the-mermaid-block-not-loading.md) - \[Where do I put my Google Analytics tracking ID?\](/docs/help-center/integrations/existing-integrations/where-do-i-put-my-google-analytics-tracking-id.md) - \[Does GitBook support Google Tag Manager?\](/docs/help-center/integrations/existing-integrations/does-gitbook-support-google-tag-manager.md) - \[How do I install the Intercom integration on my site?\](/docs/help-center/integrations/existing-integrations/how-do-i-install-the-intercom-integration-on-my-site.md) - \[Why am I seeing “We couldn’t load the integration” in GitBook?\](/docs/help-center/integrations/existing-integrations/why-am-i-seeing-we-couldnt-load-the-integration-in-gitbook.md) - \[Why are pages in the app not loading?\](/docs/help-center/further-help/why-are-pages-in-the-app-not-loading.md) - \[Where can I find API ids?\](/docs/help-center/further-help/where-can-i-find-api-ids.md) - \[How do I contact support?\](/docs/help-center/further-help/how-do-i-contact-support.md) - \[How do I generate a HAR file?\](/docs/help-center/further-help/how-do-i-contact-support/how-do-i-generate-a-har-file.md) - \[How do I download a debug log?\](/docs/help-center/further-help/how-do-i-contact-support/how-do-i-download-a-debug-log.md) - \[How do I hard refresh my browser?\](/docs/help-center/further-help/how-do-i-contact-support/how-do-i-hard-refresh-my-browser.md): Follow the steps to hard refresh your browser. - \[Resolving "Connection Lost" message\](/docs/help-center/further-help/how-do-i-contact-support/resolving-connection-lost-message.md) - \[How can I contribute to GitBook’s Documentation?\](/docs/help-center/further-help/how-can-i-contribute-to-gitbooks-documentation.md) - \[Security\](/docs/help-center/further-help/security.md) - \[Where and how is my data stored?\](/docs/help-center/further-help/security/where-and-how-is-my-data-stored.md) - \[Is GitBook SOC 2 certified?\](/docs/help-center/further-help/security/is-gitbook-soc-2-certified.md) ## Policies - \[Site Policy on GitBook\](/docs/policies/master.md) - \[Terms of Service\](/docs/policies/terms.md) - \[DMCA Takedown Policy\](/docs/policies/policies/dmca-takedown-policy.md) - \[Guide to Submitting a DMCA Takedown Notice\](/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice.md) - \[Guide to Submitting a DMCA Counter Notice\](/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice.md) - \[Name Squatting Policy\](/docs/policies/policies/name-squatting-policy.md) - \[Trademark Policy\](/docs/policies/policies/trademark-policy.md) - \[Private Spaces\](/docs/policies/policies/trademark-policy-1.md) - \[Security\](/docs/policies/privacy-and-security/security.md) - \[Reporting bugs and vulnerabilities\](/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities.md): Learn about how you can report suspected vulnerabilities or security concerns - \[Subprocessors\](/docs/policies/privacy-and-security/security/subprocessors.md) - \[Security FAQ\](/docs/policies/privacy-and-security/security/security-faq.md) - \[AI Policy\](/docs/policies/privacy-and-security/security/ai-policy.md) - \[Security as a company value\](/docs/policies/privacy-and-security/security/security-as-a-company-value.md) - \[Privacy Statement\](/docs/policies/privacy-and-security/statement.md) - \[Cookies\](/docs/policies/privacy-and-security/statement/cookies.md) --- # Editing & publishing documentation: In this section | Guides | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This section contains the following guides: [The complete guide to creating and publishing documentation in GitBook \[updated for 2025\]](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook) [Import or migrate your content to GitBook with Git Sync](https://gitbook.com/docs/guides/editing-and-publishing-documentation/import-or-migrate-your-content-to-gitbook-with-git-sync) [Import content from a CSV file into GitBook](https://gitbook.com/docs/guides/editing-and-publishing-documentation/import-zendesk-csv-to-gitbook) [How to handle merge conflicts in GitBook](https://gitbook.com/docs/guides/editing-and-publishing-documentation/how-to-handle-merge-conflicts-in-gitbook) [Find & replace or make batch changes across your GitBook docs with Git Sync](https://gitbook.com/docs/guides/editing-and-publishing-documentation/find-and-replace-or-make-batch-changes-across-your-gitbook-docs-with-git-sync) [Upload and embed a playable video into your GitBook docs](https://gitbook.com/docs/guides/editing-and-publishing-documentation/upload-and-embed-a-playable-video-into-your-gitbook-docs) Last updated 2 months ago Was this helpful? --- # The complete guide to creating and publishing documentation in GitBook [updated for 2025] | Guides | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send In this guide, we’ll walk you through the process of publishing documentation in GitBook. You can do this by creating a [docs site](https://gitbook.com/docs/publishing-documentation/publish-a-docs-site) in your GitBook organization, then linking content from your [spaces](https://gitbook.com/docs/creating-content/content-structure/space) . It’s a super-simple process that lets you control all the aspects of your published documentation in one place — including customization options, audience settings, and more. And best of all, all you need to get started is a space in GitBook with some content! ### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#how-to-create-a-docs-site) How to create a docs site Ready to publish your docs? Let’s start by creating a docs site and trying some customization options. There are a couple of different ways to do this, but they all ultimately have the same outcome. First, You can hit the plus **+** icon next to the **Docs sites** section header in the sidebar to open the site creation flow. This will guide you through the process of creating and naming your site so you can add your content or just see what a published site will look. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252Fe31vBUjZPvzLvnLO2Yi3%252Fcreate-docs-site.jpg%3Falt%3Dmedia%26token%3D1d48ef26-c6c6-4dc0-b1c4-10900b49a2ac&width=768&dpr=4&quality=100&sign=6b152bd5&sv=2) Create a new docs site from the sidebar. If you choose not to add sample content during the flow, you’ll create an empty docs site. Before you publish, you’ll need to link one or more [spaces](https://gitbook.com/docs/creating-content/content-structure/space) to your site — these act as your site’s content. Alternatively, if you know which space you want to publish, you can simply navigate to it, click **Share** in the top-right corner, then choose the **Publish to the web** tab from the menu. In this menu, you can create a new docs site or link to an existing docs site in your organization. If the space is already linked to one or more docs sites, you’ll see those listed here instead. If you haven’t already, now is a good time to name your docs site so it’s easy to find later — you can do that at the top of the site’s main dashboard. We’d recommend something descriptive to make it identifiable with a glance later. #### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#adding-more-content-to-your-site) Adding more content to your site You can link more than one space to a single docs site if you like, and there are two ways to do this — with site sections and site variants. [Site sections](https://gitbook.com/docs/publishing-documentation/site-structure/site-sections) are designed for adding different kinds of content to your site alongside your docs — such as API docs, a changelog, release notes, or anything else you need. The different sections will appear as tabs at the top of your site. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252FnPy3CmCIe669zzpWePrW%252Fsections-example.jpg%3Falt%3Dmedia%26token%3Dae1a8639-505e-42f5-a112-d207680bbd0b&width=768&dpr=4&quality=100&sign=7618b00c&sv=2) [Variants](https://gitbook.com/docs/publishing-documentation/site-structure/variants) help you show different versions of the same documentation — for example, if you want to translate your docs into other languages, or include different docs for release versions of the same product. Visitors will be able to switch between these different variants using a drop-down at the top of your published site’s sidebar. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252FUCFRRTE78Iva3WWlVU1q%252Fvariants-example.jpg%3Falt%3Dmedia%26token%3D88cc5605-41c4-44d9-8b34-2800b4e3ebd6&width=768&dpr=4&quality=100&sign=8a982088&sv=2) To add another space to your site, open the **Settings** tab from the button in the top-right and click on the **Structure** tab. Here you can see all your linked spaces, organize your content into [sections](https://gitbook.com/docs/publishing-documentation/site-structure/site-sections) and [variants](https://gitbook.com/docs/publishing-documentation/site-structure/variants) , choose the default content for your site by dragging to change the space order, and link more content to your site by clicking **Add section** or **Add variant**. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252FPDNAx2qvZRC9rzNvsrhb%252Fsite-structure.jpg%3Falt%3Dmedia%26token%3D02a93d1f-a611-421a-b27e-2387b30ffed0&width=768&dpr=4&quality=100&sign=45c0995&sv=2) Add structure to your docs using Site Sections. ### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#customize-your-site) Customize your site While you could publish at this stage without making any further changes, let’s quickly run through some of your other options. That said, if you just want to publish without making any further changes, head down to [the Publishing section below](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#audience-settings-and-publishing) to get your docs site live in seconds! Still here? Great — let’s dive into the ways in which you can customize your docs site to add branding or just make it your own. There are a ton of options to try, so we won’t explain every single one here. [Read our docs](https://gitbook.com/docs/publishing-documentation/customization) to find out more about customization options. To start customizing your docs site, open its dashboard and click **Customize** below the title. By default, you’ll begin editing the settings for your entire site — so if you’ve linked multiple spaces to a single site, these changes will apply to all of them. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252FvRuvvNvhjgkSVCvCy9OS%252Fsite-customization.jpg%3Falt%3Dmedia%26token%3D0a2f9c2c-d9dd-423d-8a3e-0f268aab18a6&width=768&dpr=4&quality=100&sign=4bdc94a2&sv=2) Customize your site from it's customization settings. You can also select individual linked spaces if you want to control settings at a more granular level. For example, if you’ve linked spaces that refer to different products or releases, you may want to customize each one in a different way to match individual brands. All the changes you make in the customization menu will appear in the preview on the right-hand side, so you can see how your choices look in context. It’s worth noting that our advanced customization options are only available if you have a Premium or Ultimate site, so if you want the full suite of controls you may need to upgrade. #### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#change-page-options) Change page options You can also change some [customizations at a content level](https://gitbook.com/docs/creating-content/content-structure/page#page-options) — including adding header images and controlling the layout of your pages. To see these options, head back to your space and roll your cursor over the title at the top of the page. In **Page Options** you can select one of our preset options, or manually toggle different controls on and off to create a custom layout. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252FLLO3lCZEfec7wJedwPuM%252Fpage-options.jpg%3Falt%3Dmedia%26token%3D5f0f2d18-03e5-4080-b364-497b31153442&width=768&dpr=4&quality=100&sign=a96bb9eb&sv=2) Update page specific settings in page options. ### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#change-your-site-s-settings) Change your site’s settings Once you’ve got your site looking the way you want, you can also take a quick look over your site’s settings. Click **Settings** in the top-right corner of your site dashboard to see your options. Here you’ll see various sections on the left-hand side. In the **General** tab, you can change your site title and slug, add a social preview image, and unpublish or delete your site. The **Audience** tab holds your [audience settings](https://gitbook.com/docs/publishing-documentation/publish-a-docs-site#publish-your-content) , and you can head to the **Domain and redirects** section to [set up a custom domain for your docs site](https://gitbook.com/docs/publishing-documentation/custom-domain) — giving it a personal or branded touch — and create manual redirects, which is handy if you’ve just imported your docs from another platform In the **Features** tab you’ll find a toggle that lets you enable or disable [AI search](https://gitbook.com/docs/creating-content/searching-your-content/gitbook-ai) — available on Premium and Ultimate sites — for your published docs. This will let you readers ask GitBook AI questions about your documentation right from the search bar, and get a summarized answer based on your content in seconds. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252Fhs59EkKsZsd0Lj6dc8zT%252Fsite-features.jpg%3Falt%3Dmedia%26token%3De42ad497-9e99-4392-a00e-25e4ba654d9a&width=768&dpr=4&quality=100&sign=5ceebee2&sv=2) Update site-wide settings in your site's settings. You can also toggle [PDF export](https://gitbook.com/docs/collaboration/pdf-export#allow-readers-to-export-a-pdf-version-of-your-published-content) on and off with a click if you have a Premium or Ultimate site. With this enabled, your docs site visitors will able to download a PDF of a single page — or the whole published space — from a button on your docs site. Below that, you can enable [page ratings](https://gitbook.com/docs/publishing-documentation/insights#feedback) , which lets users leave feedback on the content of a page and aggregates the responses to help you see how your pages rank with readers. In the **Structure** section you can organize all the content on your site. Here, you can can add [variants](https://gitbook.com/docs/publishing-documentation/site-structure/variants) to individual spaces, and also add [site sections](https://gitbook.com/docs/publishing-documentation/site-structure/site-sections) if you have an ultimate site. Head back up to [the section above](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#adding-more-content-to-your-site) to find out more. Finally, the **Plan** tab lets you upgrade or downgrade your site to a different plan. So if you want to try out site sections, AI answers or any other features that aren’t included in your plan, this is the place to go. ### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#audience-settings-and-publishing) Change audience settings and publish Once you’ve created your site and added some content, you can go right ahead an publish. By default, your site will be set to publish publicly — you can change this in the **Audience** section of your site’s **Settings** page. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252FGSXsC2deuzIP7TusXgZX%252Faudience-settings.jpg%3Falt%3Dmedia%26token%3D9c1dfda1-e145-4e64-aca9-af2f2c20df6f&width=768&dpr=4&quality=100&sign=45143ca2&sv=2) Update who can view your site. Once you’ve set your chosen audience — or if you’re happy to publish publicly — all you have to do is hit **Publish** and your site will be live! Of course, you can continue editing your site’s customization and settings when it’s live, as well as editing the content and linking more spaces if you wish. **Note:** Some of these publishing options are only available on [Premium or Ultimate sites](https://www.gitbook.com/pricing) , so if you want some of the more advanced options you may need to upgrade. #### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#public) Public As you might imagine, this publishes your site publicly, so it will be visible to everyone on the web. By default, your public site will also be indexed by search engines. If you don’t want your site to be indexed or appear in search results — such as if you’re publishing beta documentation or a version update — you can disable that in the menu. #### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#share-links) Share links With share links, you can create unique, private links to your docs to send to specific user groups. You can revoke a link at any time, so if a specific group no longer needs access to your docs it’s easy to remove them. Only people with an active link will be able to access your docs site, which won’t be indexed by search engines. #### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#authenticated-access) Authenticated access Take things one step further with [authenticated access](https://app.gitbook.com/s/NkEGS7hzeqa35sMXQZ4X/publishing-documentation/authenticated-access) . You’ll need to set up the authorization backend using either one of our auth [integrations](https://gitbook.com/docs/integrations/install-an-integration) , or with your own custom setup. Once set up, visitors to your docs will be prompted to log in using their established credentials. Only people authorized in your backend will be able to access your docs. This is ideal if you want to control exactly who can view your documentation. ### [](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook#check-the-built-in-site-analytics) Check the built-in site analytics Now that your docs site is live, let’s take a quick look at your site analytics. GitBook offers some simple [insights](https://gitbook.com/docs/publishing-documentation/insights) out of the box, and if you want more detail about your site and its performance, we have several integrations that can help — including [Google Analytics](https://www.gitbook.com/integrations/googleanalytics) , [Fathom](https://www.gitbook.com/integrations/fathom) and more. For now, let’s stick with our built-in tools. First up you can see **Traffic**, which shows you how many views your pages have had in the last seven days, four weeks and 12 months. You’ll also see a trend indicator to give you an idea of how that data compares to the previous time period. If you’ve enabled page ratings for your docs site — which you can do in the **Features** section of your site’s **Settings page** — you’ll be able to view the best- and worst-rated pages on your site in the **Feedback** card. You can use this information to focus on areas that need improvement, and try to imitate the most successful pages. Find out more about how page ratings are calculated [in our documentation](https://gitbook.com/docs/publishing-documentation/insights#feedback) . ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1940848424-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FLBGJKQic7BQYBXmVSjy0%252Fuploads%252Fcdgnix5dSOmqm7FwJZmM%252Finsights.jpg%3Falt%3Dmedia%26token%3D597ed23a-769d-4ff7-a1e7-03d8650a0c1c&width=768&dpr=4&quality=100&sign=87a605c7&sv=2) Get insights into the traffic and visitors to your site. In the Insights area you can also see your visitors’ most common search queries, which is great if you’re trying to find and fix gaps in your content. We can’t wait to see what you create! That's a quick overview of how to set up, customize and publish your first docs site in GitBook. With so many options available, you’ll be able to make every page you publish feel like your own. We love seeing your GitBook docs, so feel free to [share them with us on X (formly Twitter)](https://x.com/gitbookio) . And if you have any questions or ideas, you can [join our GitBook community](https://github.com/GitbookIO/community) , or reach out to our support team — they’d be happy to help! * * * [**→ Sign up to GitBook for free**](https://app.gitbook.com/join) [**→ Read the docs sites documentation**](https://gitbook.com/docs/publishing-documentation/publish-a-docs-site) [**→ Watch our video guides**](https://www.gitbook.com/videos) Last updated 5 months ago Was this helpful? --- # Site Policy on GitBook | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send The universe of policies and procedures that govern the use of GitBook. [](https://gitbook.com/docs/policies/terms) **Terms of Service** Please read this Terms of Service agreement carefully before accessing or using GitBook. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy) **Policies** Read about DMCA Takedown, Name Squatting and Trademark policies [](https://gitbook.com/docs/policies/privacy-and-security/security) **Privacy and Security** Read our Security FAQ and our Privacy statement Last updated 1 year ago Was this helpful? --- # Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send [](https://gitbook.com/docs/help-center#help-center) Help Center --------------------------------------------------------------------- Welcome to GitBook’s help center. We've compiled a list of common questions and answers to help you find tips, insights, and troubleshooting advice. [Ask GitBook Assistant](https://gitbook.com/docs/help-center?ask=) [Contact support](https://gitbook.com/docs/help-center/further-help/how-do-i-contact-support) * * * [](https://gitbook.com/docs/help-center/account-management/managing-your-organization) #### [](https://gitbook.com/docs/help-center#undefined) **Account management** Settings related to your organization or account. [](https://gitbook.com/docs/help-center/account-management/billing-and-payments) #### [](https://gitbook.com/docs/help-center#undefined-8) **Billing** Manage invoices, payments, and subscriptions. [](https://gitbook.com/docs/help-center/further-help/security) #### [](https://gitbook.com/docs/help-center#undefined-9) **Security** Read about GitBook's security policies. [](https://gitbook.com/docs/help-center/published-documentation/custom-domains) #### [](https://gitbook.com/docs/help-center#undefined-1) **Custom domains** Connect a personalized domain to your site. [](https://gitbook.com/docs/help-center/published-documentation/custom-domains) #### [](https://gitbook.com/docs/help-center#undefined-2) **Publishing documentation** Publish your content to the web. [](https://gitbook.com/docs/help-center/integrations/building-and-installing-integrations) #### [](https://gitbook.com/docs/help-center#undefined-3) **Integrations** Integrate your favorite tools or services. [](https://gitbook.com/docs/help-center/editing-content/writing-and-editing) #### [](https://gitbook.com/docs/help-center#undefined-4) **Editing content** Create, update, and format content. [](https://gitbook.com/docs/help-center/editing-content/managing-your-content) #### [](https://gitbook.com/docs/help-center#undefined-5) **Organizing content** Move and structure your content. [](https://gitbook.com/docs/help-center/editing-content/managing-your-content/how-can-i-export-my-content) #### [](https://gitbook.com/docs/help-center#undefined-6) **Importing & exporting** Import or export your content from GitBook. [](https://gitbook.com/docs/help-center/editing-content/assets-and-files) #### [](https://gitbook.com/docs/help-center#undefined-7) **Uploading files & assets** Add media or documents to GitBook. Last updated 18 days ago Was this helpful? --- # Private Spaces | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send #### [](https://gitbook.com/docs/policies/policies/trademark-policy-1#id-1.-control-of-private-spaces) 1\. Control of Private Spaces. Some accounts, such as paid accounts, may have private spaces, which allow the User to control access to Content. #### [](https://gitbook.com/docs/policies/policies/trademark-policy-1#id-2.-confidentiality-of-private-spaces) 2\. Confidentiality of Private Spaces. GitBook considers the contents of private spaces to be confidential to you. GitBook will protect the contents of private spaces from unauthorized use, access, or disclosure in the same manner that we would use to protect our own confidential information of a similar nature and in no event with less than a reasonable degree of care. #### [](https://gitbook.com/docs/policies/policies/trademark-policy-1#id-3.-access) 3\. Access. GitBook employees may only access the content of your private spaces in the following situations: * With your consent and knowledge, for support reasons. If GitBook accesses a private spaces for support reasons, we will only do so with the owner’s consent and knowledge. * When access is required for security reasons. You may choose to enable additional access to your private spaces. For example: * You may enable various GitBook services or features that require additional rights to Your Content in private spaces. These rights may vary depending on the service or feature, but GitBook will continue to treat your private space Content as confidential. If those services or features require rights in addition to those we need to provide the GitBook Service, we will provide an explanation of those rights. * You may also grant a third-party application authorization to use, access, and disclose the contents of your private spaces. Your use of third-party applications is at your sole risk; GitBook is not liable for disclosures to third parties that you authorize to access a private space. #### [](https://gitbook.com/docs/policies/policies/trademark-policy-1#id-4.-exclusions) 4\. Exclusions. If we have reason to believe the contents of a private space are in violation of the law or of our Terms of Service, we have the right to access, review, and remove them. Additionally, we may be [compelled by law](https://policies.gitbook.com/privacy-and-security/statement#how-we-respond-to-compelled-disclosure) to disclose the contents of your private spaces. Last updated 2 years ago Was this helpful? --- # DMCA Takedown Policy | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Welcome to GitBook's Guide to the Digital Millennium Copyright Act, commonly known as the "DMCA." This page is not meant as a comprehensive primer to the statute. However, if you've received a DMCA takedown notice targeting content you've posted on GitBook or if you're a rights-holder looking to issue such a notice, this page will hopefully help to demystify the law a bit as well as our policies for complying with it. (If you just want to submit a notice, you can [skip to the end](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#e-submitting-notices) .) As with all legal matters, it is always best to consult with a professional about your specific questions or situation. We strongly encourage you to do so before taking any action that might impact your rights. This guide isn't legal advice and shouldn't be taken as such. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#what-is-the-dmca) What Is the DMCA? ----------------------------------------------------------------------------------------------------------- In order to understand the DMCA and some of the policy lines it draws, it's perhaps helpful to consider life before it was enacted. Before the DMCA, an Internet-based service provider like GitBook could be liable for copyright infringement in the United States just for hosting its users' pictures, music, videos or code. This was true even if it had no actual knowledge of any infringing content. This was a problem, since even a single claim of copyright infringement can carry statutory damages of up to $150,000. With potential damages that high multiplied across millions of users, cloud-computing and user-generated content sites like YouTube, Facebook or GitBook probably [never would have existed](http://arstechnica.com/tech-policy/2015/04/how-the-dmca-made-youtube/) (or at least not without passing some of that cost downstream to their users). The DMCA attempted to fix this problem by creating a so-called copyright liability "safe harbor" for internet service providers hosting allegedly infringing user-generated content. (_See_ [U.S. Code, Title 17, Section 512](http://www.copyright.gov/title17/92chap5.html#512) .) Essentially, so long as a service provider follows the DMCA's notice-and-takedown rules, it won't be liable for copyright infringement based on user-generated content. Because of this it is important for GitBook to maintain its DMCA safe-harbor status. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#dmca-notices-in-a-nutshell) DMCA Notices In a Nutshell ------------------------------------------------------------------------------------------------------------------------------ The DMCA provides two simple, straightforward procedures that all GitBook users should know about: (i) a [takedown-notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice) procedure for copyright holders to request that content be removed; and (ii) a [counter-notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice) procedure for users to get content reenabled when content is taken down by mistake. DMCA [takedown notices](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice) are used by copyright owners to ask GitBook to take down infringing content. If you are a software designer or developer, you create copyrighted content every day. If someone else is using your copyrighted content in an unauthorized manner on GitBook you can send us a DMCA takedown notice to request that the infringing content be changed or removed. On the other hand, [counter notices](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice) can be used to correct mistakes. Maybe the person sending the takedown notice does not hold the copyright or did not realize that you have a license or made some other mistake in their takedown notice. Since GitBook usually cannot know if there has been a mistake, the DMCA counter notice allows you to let us know and ask that we put the content back up. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#a.-how-does-this-actually-work) A. How Does This Actually Work? --------------------------------------------------------------------------------------------------------------------------------------- The DMCA framework is a bit like passing notes in class. The copyright owner hands GitBook a complaint about a user. If it's written correctly, we pass the complaint along to the user. If the user disputes the complaint, they can pass a note back saying so. GitBook exercises little discretion in the process other than determining whether the notices meet the minimum requirements of the DMCA. It is up to the parties (and their lawyers) to evaluate the merit of their claims, bearing in mind that notices must be made under penalty of perjury. Here are the basic steps in the process. 1. **Copyright Owner Investigates.** A copyright owner should always conduct an initial investigation to confirm both (a) that they own the copyright to an original work and (b) that the content on GitBook is unauthorized and infringing. > **Example:** An employee of Acme Web Company finds some of the company's documentation in a GitBook space. Acme Web Company licenses its documentation out to several trusted partners. Before sending in a take-down notice, Acme should review those licenses and its agreements to confirm that the documentation on GitBook is not authorized under any of them. 2. **Copyright Owner Sends A Notice.** After conducting an investigation, a copyright owner prepares and sends a [takedown notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice) to GitBook. Assuming the takedown notice is sufficiently detailed according to the statutory requirements (as explained in the [how-to guide](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice) ), we will pass the notice along to the affected user. 3. **GitBook Asks User to Make Changes.** If the notice alleges that the entire contents of a space infringe, we will skip to Step 6 and disable the entire space expeditiously. Otherwise, because GitBook cannot disable access to specific pages within a space, we will contact the user who created the space and give them approximately 24 hours to delete or modify the content specified in the notice. We'll notify the copyright owner if and when we give the user a chance to make changes. 4. **User Notifies GitBook of Changes.** If the user chooses to make the specified changes, they _must_ tell us so within the approximately 24-hour window. If they don't, we will disable the space (as described in Step 6). If the user notifies us that they made changes, we will verify that the changes have been made and then notify the copyright owner. 5. **Copyright Owner Revises or Retracts the Notice.** If the user makes changes, the copyright owner must review them and renew or revise their takedown notice if the changes are insufficient. GitBook will not take any further action unless the copyright owner contacts us to either renew the original takedown notice or submit a revised one. If the copyright owner is satisfied with the changes, they may either submit a formal retraction or else do nothing. GitBook will interpret silence longer than two weeks as an implied retraction of the takedown notice. 6. **GitBook May Disable Access to the Content.** GitBook will disable a user's content if: (i) the copyright owner has alleged copyright over the user's entire space (as noted in Step 3); (ii) the user has not made any changes after being given an opportunity to do so (as noted in Step 4); or (iii) the copyright owner has renewed their takedown notice after the user had a chance to make changes. If the copyright owner chooses instead to _revise_ the notice, we will go back to Step 2 and repeat the process as if the revised notice were a new notice. 7. **User May Send A Counter Notice.** We encourage users who have had content disabled to consult with a lawyer about their options. If a user believes that their content was disabled as a result of a mistake or misidentification, they may send us a [counter notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice) . As with the original notice, we will make sure that the counter notice is sufficiently detailed (as explained in the [how-to guide](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice) ). If it is, we will pass it back to the copyright owner by sending them the link. 8. **Copyright Owner May File a Legal Action.** If a copyright owner wishes to keep the content disabled after receiving a counter notice, they will need to initiate a legal action seeking a court order to restrain the user from engaging in infringing activity relating to the content on GitBook. In other words, you might get sued. If the copyright owner does not give GitBook notice within 10-14 days, by sending a copy of a valid legal complaint filed in a court of competent jurisdiction, GitBook will reenable the disabled content. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#c.-what-if-i-inadvertently-missed-the-window-to-make-changes) C. What If I Inadvertently Missed the Window to Make Changes? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We recognize that there are many valid reasons that you may not be able to make changes within the approximate 24-hour window we provide before your space gets disabled. Maybe our message got flagged as spam, maybe you were on vacation, maybe you don't check that email account regularly, or maybe you were just busy. We get it. If you respond to let us know that you would have liked to make the changes, but somehow missed the first opportunity, we will re-enable the space one additional time for approximately 24 hours to allow you to make the changes. Again, you must notify us that you have made the changes in order to keep the space enabled after that 24-hour window, as noted above in [Step A.4](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#a-how-does-this-actually-work) . Please note that we will only provide this one additional chance. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#d.-repeated-infringement) D. Repeated Infringement -------------------------------------------------------------------------------------------------------------------------- It is the policy of GitBook, in appropriate circumstances and in its sole discretion, to disable and/or terminate the accounts of users who may infringe upon the copyrights or other intellectual property rights of GitBook and/or others. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy#e.-submitting-notices) E. Submitting Notices -------------------------------------------------------------------------------------------------------------------- If you are ready to submit a notice or a counter notice: * [How to Submit a DMCA Notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice) * [How to Submit a DMCA Counter Notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice) Last updated 1 year ago Was this helpful? --- # Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send [](https://gitbook.com/docs/help-center?ask=#help-center) Help Center -------------------------------------------------------------------------- Welcome to GitBook’s help center. We've compiled a list of common questions and answers to help you find tips, insights, and troubleshooting advice. [Ask GitBook Assistant](https://gitbook.com/docs/help-center?ask=) [Contact support](https://gitbook.com/docs/help-center/further-help/how-do-i-contact-support) * * * [](https://gitbook.com/docs/help-center/account-management/managing-your-organization) #### [](https://gitbook.com/docs/help-center?ask=#undefined) **Account management** Settings related to your organization or account. [](https://gitbook.com/docs/help-center/account-management/billing-and-payments) #### [](https://gitbook.com/docs/help-center?ask=#undefined-8) **Billing** Manage invoices, payments, and subscriptions. [](https://gitbook.com/docs/help-center/further-help/security) #### [](https://gitbook.com/docs/help-center?ask=#undefined-9) **Security** Read about GitBook's security policies. [](https://gitbook.com/docs/help-center/published-documentation/custom-domains) #### [](https://gitbook.com/docs/help-center?ask=#undefined-1) **Custom domains** Connect a personalized domain to your site. [](https://gitbook.com/docs/help-center/published-documentation/custom-domains) #### [](https://gitbook.com/docs/help-center?ask=#undefined-2) **Publishing documentation** Publish your content to the web. [](https://gitbook.com/docs/help-center/integrations/building-and-installing-integrations) #### [](https://gitbook.com/docs/help-center?ask=#undefined-3) **Integrations** Integrate your favorite tools or services. [](https://gitbook.com/docs/help-center/editing-content/writing-and-editing) #### [](https://gitbook.com/docs/help-center?ask=#undefined-4) **Editing content** Create, update, and format content. [](https://gitbook.com/docs/help-center/editing-content/managing-your-content) #### [](https://gitbook.com/docs/help-center?ask=#undefined-5) **Organizing content** Move and structure your content. [](https://gitbook.com/docs/help-center/editing-content/managing-your-content/how-can-i-export-my-content) #### [](https://gitbook.com/docs/help-center?ask=#undefined-6) **Importing & exporting** Import or export your content from GitBook. [](https://gitbook.com/docs/help-center/editing-content/assets-and-files) #### [](https://gitbook.com/docs/help-center?ask=#undefined-7) **Uploading files & assets** Add media or documents to GitBook. Last updated 18 days ago Was this helpful? --- # How can I export my content? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send You can export your GitBook content: * in Markdown format by enabling GitHub or GitLab sync * as a PDF (you may encounter limits when exporting very large spaces) [](https://gitbook.com/docs/help-center/editing-content/managing-your-content/how-can-i-export-my-content#how-to-export-content-in-markdown-format) How to export content in Markdown format ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You cannot export pages as Markdown directly within the GitBook app, but you can use GitHub or GitLab sync to sync your space with a Git repository and generate a Markdown export this way. You’ll need to synchronize the space containing the content you want to export with an empty repository. Read our documentation on [setting up the GitHub or GitLab sync](https://gitbook.com/docs/integrations/git-sync) to get started. Some custom blocks do not have a representation in Markdown, therefore they will appear as HTML in your export. Last updated 6 months ago Was this helpful? --- # What does GitBook’s trial include? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send The free trial allows you to test GitBook’s features, start onboarding your team, and create or import your content while testing all advanced features such as advanced customization, AI answers and controlled access to your site. ### [](https://gitbook.com/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include#how-do-i-start-a-free-trial) How do I start a free trial? When you create a GitBook organization, you will be asked how are you planning to use GitBook. You will be given the following options: * Published docs site for external audiences * Protected docs site to hide your content behind a login screen * Internal docs to build a knowledge base for your team If you choose to create a docs site, you will be asked if you want to: * create a free Basic site * create a Premium site * create an Ultimatum site (which contains all Premium features + authenticated access) Your trial will start only once you have published your Site to an audience or if you invite additional team members to your organization, regardless of their user permissions. ### [](https://gitbook.com/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include#do-i-have-to-provide-a-payment-method-to-start-a-free-trial) Do I have to provide a payment method to start a free trial? No! We don't ask for any payment information during your free trial. If you decide to upgrade after your trial, we will ask for a payment method. ### [](https://gitbook.com/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include#how-can-i-check-the-time-remaining-on-my-free-trial) How can I check the time remaining on my free trial? You can see the remaining trial time in the banner at the bottom of your sidebar. Alternatively, you can click on the settings icon, which is located at the bottom of the sidebar, and then click on **\[organization name\] settings**. This will take you to the general tab of that organization’s settings page. From there, click on the **plans** tab. You will see a banner on the plans page that tells you how many days remain on your free trial. This is also where you can switch your plan if required. ### [](https://gitbook.com/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include#which-features-can-i-test-during-the-free-trial) Which features can I test during the free trial? You can test all of the features of the **Pro** plan. Your site feature access will depend on which site type you choose when creating a site. Please take a look at [our pricing page](https://www.gitbook.com/pricing) to compare all of the features of our plans. ### [](https://gitbook.com/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include#what-happens-at-the-end-of-my-free-trial) What happens at the end of my free trial? After the trial finishes, you will be asked to select your plan or given an option to downgrade to free. You will have a chance to review your users and published sites before proceeding to payment and adding in your payment information. ### [](https://gitbook.com/docs/help-center/account-management/subscriptions/what-does-gitbooks-trial-include#can-i-extend-my-free-trial) Can I extend my free trial? If you have a **large organization** and you are interested in the **Enterprise** plan, we’d love to offer you some more time to onboard your team! 😊 Please get in touch via [sales@gitbook.com](mailto:sales@gitbook.com) and we’ll go discuss your requirements. Last updated 5 months ago Was this helpful? --- # Guide to Submitting a DMCA Takedown Notice | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This guide describes the information that GitBook needs in order to process a DMCA takedown request. If you have more general questions about what the DMCA is or how GitBook processes DMCA takedown requests, please review our [DMCA Takedown Policy](https://gitbook.com/docs/policies/policies/dmca-takedown-policy) . Due to the type of content GitBook hosts (mostly software code) and the way that content is managed (with Git), we need complaints to be as specific as possible. These guidelines are designed to make the processing of alleged infringement notices as straightforward as possible. Our form of notice set forth below is consistent with the form suggested by the DMCA statute, which can be found at the U.S. Copyright Office's official website: [http://www.copyright.gov](http://www.copyright.gov/) . As with all legal matters, it is always best to consult with a professional about your specific questions or situation. We strongly encourage you to do so before taking any action that might impact your rights. This guide isn't legal advice and shouldn't be taken as such. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice#before-you-start) Before You Start ----------------------------------------------------------------------------------------------------------------------------------------------------- _**Tell the Truth.**_ The DMCA requires that you swear to the facts in your copyright complaint _under penalty of perjury_. It is a federal crime to intentionally lie in a sworn declaration. (_See_ [U.S. Code, Title 18, Section 1621](http://www.gpo.gov/fdsys/pkg/USCODE-2011-title18/html/USCODE-2011-title18-partI-chap79-sec1621.htm) .) Submitting false information could also result in civil liability—that is, you could get sued for money damages. _**Investigate.**_ Millions of users and organizations pour their hearts and souls into the projects they create and contribute to on GitBook. Filing a DMCA complaint against such a project is a serious legal allegation that carries real consequences for real people. Because of that, we ask that you conduct a thorough investigation and consult with an attorney before submitting a takedown to make sure that the use isn't actually permissible. _**Ask Nicely First.**_ A great first step before sending us a takedown notice is to try contacting the user directly. They may have listed contact information in their content. This is not strictly required, but it is classy. _**No Bots.**_ You should have a trained professional evaluate the facts of every takedown notice you send. If you are outsourcing your efforts to a third party, make sure you know how they operate, and make sure they are not using automated bots to submit complaints in bulk. These complaints are often invalid and processing them results in needlessly taking down projects! _**You May Receive a Counter Notice.**_ Any user affected by your takedown notice may decide to submit a [counter notice](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice) . If they do, we will re-enable their content within 10-14 days unless you notify us that you have initiated a legal action seeking to restrain the user from engaging in infringing activity relating to the content on GitBook. _**GitBook Isn't The Judge.**_ GitBook exercises little discretion in the process other than determining whether the notices meet the minimum requirements of the DMCA. It is up to the parties (and their lawyers) to evaluate the merit of their claims, bearing in mind that notices must be made under penalty of perjury. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice#your-complaint-must) Your Complaint Must ... --------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Include the following statement: "I have read and understand GitBook's Guide to Filing a DMCA Notice."** We won't refuse to process an otherwise complete complaint if you don't include this statement. But we'll know that you haven't read these guidelines and may ask you to go back and do so. 2. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. 3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitBook to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole space infringes, identify the specific page(s) that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. 4. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain part of their contents, or entire pages? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. 5. **Provide your contact information.** Include your email address, name, telephone number and physical address. 6. **Provide contact information, if you know it, for the alleged infringer.** Usually this will be satisfied by providing the GitBook username associated with the allegedly infringing content. But there may be cases where you have additional knowledge about the alleged infringer. If so, please share that information with us. 7. **Include the following statement: "I have a good faith belief that use of the copyrighted materials described above on the infringing web pages is not authorized by the copyright owner, or its agent, or the law. I have taken fair use into consideration."** 8. **Also include the following statement: "I swear, under penalty of perjury, that the information in this notification is accurate and that I am the copyright owner, or am authorized to act on behalf of the owner, of an exclusive right that is allegedly infringed."** 9. **Include your physical or electronic signature.** [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-takedown-notice#how-to-submit-your-complaint) How to Submit Your Complaint ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can contact us by sending an email notification to [support@gitbook.com](mailto:support@gitbook.com) . You may include an attachment if you like, but please also include a plain-text version of your message in the body of your email. Last updated 1 year ago Was this helpful? --- # Reporting bugs and vulnerabilities | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Occasionally we are contacted about suspected vulnerabilities or security concerns. Please note that we do take those extremely seriously and investigate each report. [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#how-to-report-suspected-vulnerabilities-or-security-concerns) How to report suspected vulnerabilities or security concerns? -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To report vulnerabilities, please contact us at support@gitbook.com with a title 'Vulnerability Report'. For all other bugs please provide a specific title relating to the are where the bug occured. To help us respond to you faster, please share the steps to reproduce the behaviour. Our team will triage your report and respond to you with next steps. ### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#what-happens-after-i-report-my-concern) What happens after I report my concern? When we receive your report our team will triage and investigate it. We will confirm the receipt of your report and may also ask you for additional information to help us understand the scale of the problem. Next, our team will run tests and confirm if you have identified a previously unknown issue. ### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#which-vulnerabilities-should-i-not-report) Which vulnerabilities should I not report? * Denial of service * Disclosure of server or software version numbers * Hypothetical subdomain takeovers without supporting evidence * Issues that are premised on unlikely user interaction * Missing best practices in SSL/TLS configuration * Missing email best practices * Missing HttpOnly or Secure flags on cookies * Previously known vulnerable libraries without a working Proof-of-Concept * Public Zero-day vulnerabilities that have had an official patch for less than 1 month will be awarded on a case-by-case basis * Rate limiting or brute force issues on non-authentication endpoints * Reports exploiting the behavior of, or vulnerabilities in, outdated browsers * Reports of spam * Social engineering * Tabnabbing * Unconfirmed reports from automated vulnerability scanners * Attacks requiring MITM or physical access to a user's device * Best practice reports without a valid exploit * Clickjacking on pages with no sensitive actions * Comma Separated Values (CSV) injection without demonstrating a vulnerability * Content spoofing and text injection issues without showing an attack vector/without being able to modify HTML/CSS * Cross-Site Request Forgery (CSRF) on unauthenticated forms or forms with no sensitive actions [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#do-you-offer-any-rewards-or-bug-bounties-for-reporting-a-vulnerability) Do you offer any rewards or bug bounties for reporting a vulnerability? ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We are a small distributed team which means we are unable to offer financial rewards for reporting vulnerabilities at this stage. We still would like to show our appreciation for your help in making GitBook better and safer by offering you a **discount on your subscription.** #### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#user-content-program-eligibility) Eligibility * must be at least 18 years old. * GitBook employees and contractors, as well as their family members, are strictly prohibited from participating in the Program or sharing information with an external security researcher to bypass this prohibition. #### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#rules-of-engagement) Rules of Engagement * Your submission must include a working Reproduction Guide to be considered for a reward. * Avoid harm to others’ data and privacy. Specifically: * If you encounter any personal data or sensitive information in the course of your research, **stop and notify our team immediately so we can investigate**. Please report to us what data was accessed and delete the data. Do not save, copy, download, transfer, disclose, or otherwise use this data. Continuing to access others’ data or otherwise failing to adhere to this requirement will disqualify you from receiving any reward. * If your research is designed to identify and demonstrate a vulnerability that could allow unauthorized access to personal data or sensitive information, make sure to take measures to minimize your access to or usage of such data to what is **absolutely necessary** to achieve those purposes (i.e., identification and demonstration of a vulnerability that could allow unauthorized access to personal data or sensitive information). For example, if you are injecting code into GitBook environment to test whether you could exfiltrate data from a GitBook's database, limit the potential exfiltration to the first three rows and five columns of the table rather than the entire database. * If, even after taking measures to minimize access to personal data or sensitive information, you ultimately end up encountering such data in the course of your research, follow the mitigation measures described above * Do not leverage the existence of a vulnerability or access to personal data or sensitive information to make threats or extortionate demands. Do not degrade, interrupt, or deny services to our users or take any actions that can affect the availability or integrity of GitBook's systems and data (e.g., modifying or deleting data). If you notice service degradation or interruption, stop your research and notify us immediately. * Do not incur a loss of funds that are not your own. * We consider only the earliest, responsibly-disclosed submission of a vulnerability instance with enough actionable information to identify the issue for a reward. All other reports for a given issue will not be eligible for a reward. * Your research must not violate any applicable laws or regulations. #### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#user-content-submission-review-process) Submission Review Process After a submission is sent to GitBook in accordance with the Rules of Engagement described above, GitBook engineers will review the submission and validate its eligibility for a reward. The review time could vary depending on the complexity and completeness of your submission, as well as on the number of submissions we receive. As explained in the Engagement section, GitBook retains sole discretion in determining which submissions are qualified for a reward. If we receive multiple bug reports for the same issue from different parties, the bounty will be granted to the first eligible submission. If a duplicate report provides new information that was previously unknown to GitBook, we may award a differential to the person submitting the duplicate report. GItBook will also reopen and reward any report mistakenly closed as invalid if we later receive and reward the same bug reported by someone else. In these situations, we will reward both researchers. #### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#disclosure) Disclosure By participating in this program, you agree not to publicly or privately disclose the contents of your submission, your findings, your communications with GitBook related to your report, or any facts you have learned about GitBook in the course of this report to any third party without GitBook's prior written approval. There are no exceptions. #### [](https://gitbook.com/docs/policies/privacy-and-security/security/reporting-bugs-and-vulnerabilities#user-content-accountability) Accountability GitBook reserves the right to disqualify you from participating if you violate the Rules of Engagement or other rules specified in this program policy, including the rules about disclosure. Last updated 2 years ago Was this helpful? --- # Guide to Submitting a DMCA Counter Notice | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This guide describes the information that GitBook needs in order to process a counter notice to a DMCA takedown request. If you have more general questions about what the DMCA is or how GitBook processes DMCA takedown requests, please review our [DMCA Takedown Policy](https://gitbook.com/docs/policies/policies/dmca-takedown-policy) . If you believe your content on GitBook was mistakenly disabled by a DMCA takedown request, you have the right to contest the takedown by submitting a counter notice. If you do, we will wait 10-14 days and then re-enable your content unless the copyright owner initiates a legal action against you before then. Our counter-notice form, set forth below, is consistent with the form suggested by the DMCA statute, which can be found at the U.S. Copyright Office's official website: [http://www.copyright.gov](http://www.copyright.gov/) . As with all legal matters, it is always best to consult with a professional about your specific questions or situation. We strongly encourage you to do so before taking any action that might impact your rights. This guide isn't legal advice and shouldn't be taken as such. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice#before-you-start) Before You Start ---------------------------------------------------------------------------------------------------------------------------------------------------- _**Tell the Truth.**_ The DMCA requires that you swear to your counter notice _under penalty of perjury_. It is a federal crime to intentionally lie in a sworn declaration. (_See_ [U.S. Code, Title 18, Section 1621](http://www.gpo.gov/fdsys/pkg/USCODE-2011-title18/html/USCODE-2011-title18-partI-chap79-sec1621.htm) .) Submitting false information could also result in civil liability—that is, you could get sued for money damages. _**Investigate.**_ Submitting a DMCA counter notice can have real legal consequences. If the complaining party disagrees that their takedown notice was mistaken, they might decide to file a lawsuit against you to keep the content disabled. You should conduct a thorough investigation into the allegations made in the takedown notice and probably talk to a lawyer before submitting a counter notice. _**You Must Have a Good Reason to Submit a Counter Notice.**_ In order to file a counter notice, you must have "a good faith belief that the material was removed or disabled as a result of mistake or misidentification of the material to be removed or disabled." ([U.S. Code, Title 17, Section 512(g)](http://www.copyright.gov/title17/92chap5.html#512) .) Whether you decide to explain why you believe there was a mistake is up to you and your lawyer, but you _do_ need to identify a mistake before you submit a counter notice. In the past, we have received counter notices citing mistakes in the takedown notice such as: the complaining party doesn't have the copyright; I have a license; the content has been released under a license that permits my use; or the complaint doesn't account for the fact that my use is protected by the fair-use doctrine. Of course, there could be other defects with the takedown notice. _**A Counter Notice Is A Legal Statement.**_ We require you to fill out all fields of a counter notice completely, because a counter notice is a legal statement — not just to us, but to the complaining party. As we mentioned above, if the complaining party wishes to keep the content disabled after receiving a counter notice, they will need to initiate a legal action seeking a court order to restrain you from engaging in infringing activity relating to the content on GitBook. In other words, you might get sued (and you consent to that in the counter notice). _**GitBook Isn't The Judge.**_ GitBook exercises little discretion in this process other than determining whether the notices meet the minimum requirements of the DMCA. It is up to the parties (and their lawyers) to evaluate the merit of their claims, bearing in mind that notices must be made under penalty of perjury. _**Additional Resources.**_ If you need additional help, there are many self-help resources online. Lumen has an informative set of guides on [copyright](https://www.lumendatabase.org/topics/5) and [DMCA safe harbor](https://www.lumendatabase.org/topics/14) . If you are involved with an open-source project in need of legal advice, you can contact the [Software Freedom Law Center](https://www.softwarefreedom.org/about/contact/) . And if you think you have a particularly challenging case, non-profit organizations such as the [Electronic Frontier Foundation](https://www.eff.org/pages/legal-assistance) may also be willing to help directly or refer you to a lawyer. [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice#your-counter-notice-must) Your Counter Notice Must... ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Include the following statement: "I have read and understand GitBook's Guide to Filing a DMCA Counter Notice."** We won't refuse to process an otherwise complete counter notice if you don't include this statement; however, we will know that you haven't read these guidelines and may ask you to go back and do so. 2. _**Identify the content that was disabled and the location where it appeared.**_ The disabled content should have been identified by URL in the takedown notice. You simply need to copy the URL(s) that you want to challenge. 3. **Provide your contact information.** Include your email address, name, telephone number, and physical address. 4. _**Include the following statement: "I swear, under penalty of perjury, that I have a good-faith belief that the material was removed or disabled as a result of a mistake or misidentification of the material to be removed or disabled."**_ You may also choose to communicate the reasons why you believe there was a mistake or misidentification. If you think of your counter notice as a "note" to the complaining party, this is a chance to explain why they should not take the next step and file a lawsuit in response. This is yet another reason to work with a lawyer when submitting a counter notice. 5. _**Include the following statement: "I consent to the jurisdiction of Federal District Court for the judicial district in which my address is located (if in the United States, otherwise the Northern District of California where GitBook is located), and I will accept service of process from the person who provided the DMCA notification or an agent of such person."**_ 6. **Include your physical or electronic signature.** [](https://gitbook.com/docs/policies/policies/dmca-takedown-policy/guide-to-submitting-a-dmca-counter-notice#how-to-submit-your-counter-notice) How to Submit Your Counter Notice -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- You can contact us by sending an email notification to [support@gitbook.com](mailto:support@gitbook.com) . You may include an attachment if you like, but please also include a plain-text version of your message in the body of your email. Last updated 1 year ago Was this helpful? --- # How can I transfer billing and invoice management to another team member? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send **Option 1: Update billing email only** 1. Go to Organization Settings → Billing → Manage Billing 2. In Stripe, update the billing email address 3. This person will receive invoices but won't have GitBook access **Option 2: Transfer admin access** 1. Make the new person an Admin in your organization 2. They can then access Organization Settings → Billing 3. Update payment method and billing details as needed 4. Remove your admin access if desired **Option 3: Change organization ownership** * Add the new person as an Admin * Remove other admins if you want single control * The admin can manage all billing and team settings **Important considerations:** * Only organization Admins can access billing settings * Billing email changes only affect who receives invoices * Payment method changes require access to the Stripe billing portal **For enterprise customers:** Contact support for assistance with billing contact changes and invoice customization. Last updated 3 months ago Was this helpful? --- # If I subscribe to a paid plan, can I remove the "Powered by GitBook" badge? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send No, removing the "Powered by GitBook" link is not an option that we provide. Last updated 11 months ago Was this helpful? --- # Inline content | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send ![A GitBook screenshot showing inline content options](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FTUAHcyqQIRn7MgF4wUMD%252Fcreating-content-formatting-your-content-inline.svg%3Falt%3Dmedia%26token%3Def5b5f37-0a70-4b4d-9458-61156cd1cd38&width=768&dpr=4&quality=100&sign=810d65a&sv=2) Add inline elements to your content. The inline palette lets you quickly add extra content to your text block without moving your hands away from the keyboard. Simply hit `/` on any text block to open the inline palette. The forward slash will be replaced by the content you choose to insert. ### [](https://gitbook.com/docs/creating-content/formatting/inline#annotations) Annotations With annotations, you can add extra context to your words without breaking the reader’s train of thought. You can use them to explain the meaning of a word, insert extra information, and more. Readers can hover over the annotated text to show the annotation above the text. #### [](https://gitbook.com/docs/creating-content/formatting/inline#create-an-annotation) Create an annotation To create an annotation, select the text you would like to annotate and click the **Annotate** option in the context menu. Once you’ve written your annotation, click outside of it to continue writing in the text block. #### [](https://gitbook.com/docs/creating-content/formatting/inline#markdown-representation) Markdown representation You can write content as [Markdown footnotes](https://www.markdownguide.org/extended-syntax/#footnotes) to add them as annotations in GitBook. Footnote indicators should appear immediately after the word you wish to annotate; they should not appear after punctuation marks or other symbols. Copy Here's a simple footnote[^1], and here's a longer one[^bignote]. [^1]: This is the first footnote. [^bignote]: Here's one with multiple paragraphs and code. Indent paragraphs to include them in the footnote. `{ my code }` Add as many paragraphs as you like. ### [](https://gitbook.com/docs/creating-content/formatting/inline#images) Images Inline images will sit alongside your text on the page. By default, images are set to their original size with a maximum width of 300px. You can change the size by clicking the image to open the formatting palette, then choosing one of the three options: 1. **Inline size:** The image is proportionally sized to the font — great for icons and badges. 2. **Original size:** The image will remain inline at its original size, with a maximum width of 300 pixels. 3. **Convert to block:** This turns an inline image into a [image block](https://gitbook.com/docs/creating-content/blocks/insert-images) , which is as wide as your content. [Image blocks](https://gitbook.com/docs/creating-content/blocks/insert-images) offer more options, including more sizes and the ability to add a caption — but will not appear inline with your text. #### [](https://gitbook.com/docs/creating-content/formatting/inline#representation-in-markdown) Representation in Markdown Copy Here is an inline image: Dark version of GitBook logo ### [](https://gitbook.com/docs/creating-content/formatting/inline#emojis) Emojis You can add emojis by hitting `/` to open the inline palette. Alternatively, type `:` and a list of emojis will pop up directly in line — you can start typing the name of an emoji to narrow down the selection. #### [](https://gitbook.com/docs/creating-content/formatting/inline#representation-in-markdown-1) Representation in Markdown Copy :house: :car: :dog: ### [](https://gitbook.com/docs/creating-content/formatting/inline#links) Links You can insert three different types of links: * [Relative links](https://gitbook.com/docs/creating-content/formatting/inline#relative-links) * [Absolute links](https://gitbook.com/docs/creating-content/formatting/inline#absolute-links) * [Email address `mailto` links](https://gitbook.com/docs/creating-content/formatting/inline#email-address-mailto-links) #### [](https://gitbook.com/docs/creating-content/formatting/inline#relative-links) Relative links Relative links are links created by linking to [pages](https://gitbook.com/docs/creating-content/content-structure/page) that already exist in your space. The advantage of using relative links is that if the page’s URL, name, or location changes, its reference will be kept up to date — so you’ll end up with fewer broken links. Here’s how to insert a relative link: 1. Click somewhere in your paragraph where you want to insert the link, or select some text. 2. Hit / to open the inline palette and choose Link, click the **Link** button in the context menu, or hit **⌘ + K**. 3. Start typing the title of the page you want to link to. 4. Select the page from the drop-down search results. 5. Hit `Enter`. #### [](https://gitbook.com/docs/creating-content/formatting/inline#absolute-links) Absolute links Absolute links are external links that you can copy and paste into your content. They’re great when you want to link to something outside your documentation. To insert an absolute link: 1. Click somewhere in your paragraph where you want to insert the link, or select some text. 2. Hit / to open the inline palette and choose Link, click the **Link** button in the context menu, or hit **⌘ + K**. 3. Paste the URL you want to link to. 4. Hit `Enter`. #### [](https://gitbook.com/docs/creating-content/formatting/inline#why-dont-external-links-open-in-a-new-tab) Why don't external links open in a new tab? When you add a link to an external site in your docs, it will open in the same tab. GitBook follows this [W3C-recommended behavior](https://www.w3.org/TR/WCAG20-TECHS/G200.html) to support [accessibility](https://it.wisc.edu/learn/make-it-accessible/websites-and-web-applications/when-to-open-links-in-a-new-tab/) and ensure a consistent, inclusive experience for your readers. #### [](https://gitbook.com/docs/creating-content/formatting/inline#email-address-mailto-links) Email address mailto links Email address `mailto` links are useful when you want your visitors to click on a link that will open up their default email client and fill in the `To` field with the email address of your link, so they can write an email to send. Here’s how to insert an email address `mailto` link: 1. Click somewhere in your paragraph where you want to insert the link, or select some text. 2. Hit / to open the inline palette and choose Link, click the **Link** button in the context menu, or hit **⌘ + K**. 3. Paste or type `mailto:something@address.com`, replacing `something@address.com` with the email address you would like to use. 4. Hit `Enter`. #### [](https://gitbook.com/docs/creating-content/formatting/inline#representation-in-markdown-2) Representation in Markdown Copy [This is a relative link to another page in this space](../content-structure/page.md) [This is an absolute link](https://www.gitbook.com/blog) [This is a link](mailto:support@gitbook.com) to our support email address ### [](https://gitbook.com/docs/creating-content/formatting/inline#math-and-tex) Math & TeX Using this option, you can create an inline math formula in your content, like this: f(x)\=x∗e2piiξxf(x) = x \* e^{2 pi i \\xi x}f(x)\=x∗e2piiξx. We use the [KaTeX](https://katex.org/docs/supported.html) library to render formulas. You can also insert [a block-level math formula](https://gitbook.com/docs/creating-content/blocks/math-and-tex) by opening the command palette in an empty block and choosing the second Math & TeX option. #### [](https://gitbook.com/docs/creating-content/formatting/inline#representation-in-markdown-3) Representation in Markdown Copy # Math and TeX block $$f(x) = x * e^{2 pi i \xi x}$$ ### [](https://gitbook.com/docs/creating-content/formatting/inline#buttons) Buttons Buttons are a great way to describe calls to action. You can use them to send users to other pages in GitBook, or to external URLs. Buttons have both primary and secondary styles. Here are a couple of examples: [Sign up to GitBook](https://app.gitbook.com/join) [Go to top](https://gitbook.com/docs/creating-content/formatting/inline#annotations) #### [](https://gitbook.com/docs/creating-content/formatting/inline#representation-in-markdown-4) Representation in Markdown Copy GitBook ### [](https://gitbook.com/docs/creating-content/formatting/inline#icons) Icons Icons allow you to add extra visual indications to your site. You can add them inline to paragraphs, inside a card, or anywhere else you need to add some flair. They will use the visual style defined in your [customization settings](https://gitbook.com/docs/publishing-documentation/customization/icons-colors-and-themes) . Visit [Font Awesome](https://fontawesome.com/) to explore the different icons available. #### [](https://gitbook.com/docs/creating-content/formatting/inline#representation-in-markdown-5) Representation in Markdown Copy :github: ### [](https://gitbook.com/docs/creating-content/formatting/inline#expressions) Expressions Expressions allow you to dynamically display content defined in a [variable](https://gitbook.com/docs/creating-content/variables-and-expressions) . Expressions can be inserted from the `/` menu. Once inserted, double clicking on the expression will bring up the expression editor, allowing you to reference and [conditionally format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_operator) your variable. Last updated 1 month ago Was this helpful? --- # Security FAQ | Policies | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#what-is-gitbook) What is GitBook? ---------------------------------------------------------------------------------------------------------------------- GitBook is a tech startup, incorporated in the U.S as `GitBook Inc` , with a French subsidiary `GitBook SAS` [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#where-is-gitbook-hosted) Where is GitBook hosted? -------------------------------------------------------------------------------------------------------------------------------------- We are hosted on [**Google Cloud**](https://cloud.google.com/security/overview/) , which is backed by the same **infrastructure and security that Google uses** for its own services. Customer data is stored in U.S. data centers. Some data (HTML pages & assets) may be cached in other geographies by our CDN. Access to private content through our CDN is always validated through our application servers using a complex permissions system. Google follows or even leads most of the **industry's best-practices** and is compliant with most **major security** [**standards and certifications**](https://cloud.google.com/security/compliance/) . [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#is-customer-data-encrypted) Is customer data encrypted? -------------------------------------------------------------------------------------------------------------------------------------------- Yes, all customer data is encrypted at rest and in-transit: * In transit, we use **HTTPS to encrypt all traffic** served to end-users. * Even user-provided **custom domains are covered**, thanks to [LetsEncrypt](https://letsencrypt.org/) and Cloudflare. * At rest on **Google Cloud Platform**, using [**multiple layers of AES256-AES128**](https://cloud.google.com/security/encryption-at-rest/default-encryption/resources/encryption-whitepaper.pdf) **.** [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#how-are-users-authenticated) How are users authenticated? ---------------------------------------------------------------------------------------------------------------------------------------------- By default, all customer data, unless explicitly public, can only be accessed by authenticated users with **valid permissions**. You can control and restrict access through our [**Teams feature**](https://docs.gitbook.com/organization-management/setting-up-permissions#teams) , allowing you to invite external members to join your organization and collaborate, whilst **restricting their access** to a chosen subset of your projects. [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#which-user-company-data-is-required-to-operate-on-gitbook) Which user/company data is required to operate on GitBook? ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The only required piece of information to sign up and start using GitBook is an **email address**. Depending on the risk evaluation performed using the [Clearbit Risk API](https://clearbit.com/risk) , a phone number may be necessary for new users. The risk evaluation is based on a combination of the provided **email address** and the **visitor's IP address**. When subscribing to a plan, the user will be asked for **credit card informations**. These informations never reach our servers and are **processed by** [**Stripe**](https://stripe.com/) **only**. [Stripe](https://stripe.com/) gives us access to the expiration date, the brand and the last 4 digits of the credit card only, which are **stored in our database for convenience**. The user can opt-in to provide us with a billing address, which is also stored in our database. As for the credit card partial informations, the billing address is **private** and **only accessible** by the GitBook organization's and the application's administrators. [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#what-other-3rd-party-services-process-data) What other 3rd-party services process data? ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- GitBook leverages the following 3rd-party services and APIs: * [Algolia](https://www.algolia.com/) for Search * [Stripe](https://stripe.com/) for Payments * [Help Scout](https://www.helpscout.com/) for Support * [Clearbit](https://clearbit.com/) for Sign up risk evaluation * [Amplitude](https://amplitude.com/) and [Google Analytics](https://www.google.com/analytics/) for Analytics * [Google Cloud](https://cloud.google.com/) for hosting (data & compute) Since these services provide the **highest standards** and are regularly **externally audited**, GitBook does not audit them by its own means. [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#how-are-role-based-permissions-applied-on-gitbook) How are role-based permissions applied on GitBook? ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Each user on GitBook is assigned a **unique identifier** when her/his account is created. When creating or joining a GitBook organization, each user is then assigned **a role**: reader, writer or admin. This role is then used to **derivate a set of permissions** for each member of the organization. These permissions are then applied directly **at the database level**, thanks to the [**Firebase Realtime Database security rules**](https://firebase.google.com/docs/database/security/user-security) . For each request that reaches our database, the user's unique identifier is sent along. Based on the user's unique identifier and the set of permissions associated with its role **at the time of the request**, the database will either accept or reject the request. Thanks to this, the user's access to an organization's content is **automatically revoked** when she/he is removed from the said organization. [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#how-well-is-gitbook-protected-against-common-web-application-vulnerabilities) How well is GitBook protected against common web application vulnerabilities? ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Google Cloud Functions, that are used to serve our application, live behind the Google Frontend. They are protected against brute force/DDoS attacks the **same way that** [**google.com**](https://google.com/) **protects itself**. In addition, since Firebase Authentication is the gateway to many of our backend services and security rules, many of our quotas are protected by per-IP limits to give an extra layer of **protection against a localized attack**. [](https://gitbook.com/docs/policies/privacy-and-security/security/security-faq#is-gitbook-soc2-certified) Is GitBook SOC2 certified? ------------------------------------------------------------------------------------------------------------------------------------------ Yes, we are. You can read more about [security as our company](https://gitbook.com/docs/policies/privacy-and-security/security/security-as-a-company-value#soc-2-type-2) value and our certification on the next page. Last updated 1 year ago Was this helpful? --- # Where can I find my invoices, and how do I update billing details? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send GitBook uses Stripe for billing. To access your invoices: 1. Click **Settings** at the bottom of your sidebar 2. Click **Organization Settings** 3. Click **Billing** → **Manage Billing** (redirects you to Stripe) 4. Navigate to **Invoice History** and click the arrow (↗️) next to any payment to download **To update billing information:** * In the Stripe billing portal, click "Update Information" in the billing information section * **Important:** Update billing details BEFORE making payments - we cannot modify details on already-paid invoices We cannot change company information on existing invoices Last updated 3 months ago Was this helpful? --- # Can I edit GitBook on a smartphone? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Currently, GitBook does not support editing on smartphones. While you can access your organization and view content using a smartphone, editing features are only available on a laptop or computer. To make any changes, you’ll need to use a desktop or laptop device. Last updated 11 months ago Was this helpful? --- # Is there a storage limit for asset uploads? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send 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 if we see any abuse. There is an upload limit of 50MB for each asset. ### [](https://gitbook.com/docs/help-center/editing-content/assets-and-files/is-there-a-storage-limit-for-asset-uploads#unexpected-error-when-uploading-images) Unexpected Error when uploading images `Unexpected Error` Please note that there is a file size limitation for image uploads. Ensure your image is below the 50MB threshold. ### [](https://gitbook.com/docs/help-center/editing-content/assets-and-files/is-there-a-storage-limit-for-asset-uploads#how-can-i-upload-assets-that-are-bigger-than-50-mb-to-gitbook) How can I upload assets that are bigger than 50 MB to GitBook? If you need to upload files larger than the 50MB limit, the best solution is to store them somewhere like Dropbox or Google Drive and add a link to them in GitBook. ### [](https://gitbook.com/docs/help-center/editing-content/assets-and-files/is-there-a-storage-limit-for-asset-uploads#can-i-upload-and-embed-gifs-in-gitbook) Can I upload and embed gifs in GitBook? Yes, you can add gifs to your page in GitBook. There are two limitations to keep in mind: * There is a 50MB upload limit on individual files in GitBook. If your gif is larger than 50MB you will need to reduce its size before you upload. * There is a 200 frame limit per gif file. If your gif has more than 200 frames, you will need to reduce the number of frames before you upload. Any large file — gifs included — will slow the performance and loading time of your page. We recommend you avoid uploading and embedding large files directly to maximize performance. Last updated 4 months ago Was this helpful? --- # I have paid for the yearly plan. Why did I receive another invoice? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This happens when you have added extra users since subscribing to an annual plan. Each user (regardless of their permission level) is considered a paid seat. Read more about how we work out the outstanding fees in our [billing policy](https://gitbook.com/docs/account-management/plans/billing-policy) . Last updated 6 months ago Was this helpful? --- # Managing API operations | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send It’s common to have operations that are not fully stable yet or that need to be phased out. GitBook supports several OpenAPI extensions to help you manage these scenarios. ### [](https://gitbook.com/docs/api-references/guides/managing-api-operations#marking-operation-as-experimental-alpha-or-beta) Marking operation as experimental, alpha, or beta Use `x-stability` to communicate that an endpoint is unstable or in progress. It helps users avoid non-production-ready endpoints. Supported values: `experimental`, `alpha`, `beta`. openapi.yaml Copy paths: /pet: put: operationId: updatePet x-stability: experimental ### [](https://gitbook.com/docs/api-references/guides/managing-api-operations#deprecating-an-operation) Deprecating an operation To mark an operation as deprecated, add the `deprecated: true` attribute. openapi.yaml Copy paths: /pet: put: operationId: updatePet deprecated: true Optionally specify when support ends by including `x-deprecated-sunset` openapi.yaml Copy paths: /pet: put: operationId: updatePet deprecated: true x-deprecated-sunset: 2030-12-05 ### [](https://gitbook.com/docs/api-references/guides/managing-api-operations#hiding-an-operation-from-the-api-reference) Hiding an operation from the API reference To hide an operation from your API reference, add `x-internal: true` or `x-gitbook-ignore: true` attribute. openapi.yaml Copy paths: /pet: put: operationId: updatePet x-internal: true ### [](https://gitbook.com/docs/api-references/guides/managing-api-operations#hiding-a-response-sample) Hiding a response sample Add the `x-hideSample: true` attribute to a response object to exclude it from the response samples section. openapi.yaml Copy paths: /pet: put: operationId: updatePet responses: 200: x-hideSample: true Last updated 2 months ago Was this helpful? --- # My custom subdomain isn't working. How do I troubleshoot DNS issues? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Custom domain issues are usually DNS-related. Here's how to troubleshoot: **Check your DNS configuration:** 1. Verify you created a **CNAME record** (not an A record) pointing to the value GitBook provided. 2. Ensure you're using the subdomain format (`docs.yoursite.com` or `www.yoursite.com` 3. If using Cloudflare, **disable the orange cloud (proxy)** - it must be set to "DNS only" **Common DNS issues:** * **Conflicting records**: Remove any existing A, AAAA, or other records for the same subdomain * **TTL delays**: DNS changes can take up to 48 hours to propagate globally * **CAA records**: If you have CAA records, add `0 issue "pki.goog"` to allow GitBook's SSL certificates **Test your setup:** Use a DNS lookup tool like [WhatsMyDNS.net](https://www.whatsmydns.net/#CNAME) to verify your CNAME record is pointing to the correct GitBook address. If you continue having issues after 48 hours, [contact support](https://www.gitbook.com/contact) with your domain name and the CNAME value GitBook provided. Last updated 3 months ago Was this helpful? --- # How can I make sure my company info is included on my receipts? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Please head to the **organization settings**, then click on **billing**. You can amend the billing details by clicking on update information in the billing information section of your Stripe dashboard. Please ensure your billing information is correct _**before**_ you pay for a subscription. We are unable to change details on already paid invoices. Was this helpful? --- # Where can I find my receipts or invoices? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send We use Stripe's localized payment methods to support our users' most common payment methods globally. To access and review your invoices: 1. Click on **Settings** at the bottom of your sidebar. 2. Click on **Organization Settings**. 3. Click **Billing**. You'll find it at the bottom of the side panel. This will redirect you to your subscription information in Stripe. 4. Once in Stripe, navigate to **invoice history** at the bottom of the page and click the arrow `↗️` next to the payment you want to find. This will bring you to a page where you can download your receipts and invoices. Last updated 1 year ago Was this helpful? --- # How do I change or update my custom domain in GitBook? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send You can easily update your custom domain through your site settings: 1. Navigate to your **Docs Sites** in the left sidebar 2. Select the site where you want to change the domain 3. Click **Settings** at the top of the site page 4. Go to **Domain and URL** section. The URL will look like this: [https://app.gitbook.com/o/sites/settings/domains](https://app.gitbook.com/o/sites/settings/domains) 5. You can either: * Remove the current domain and add a new one * Edit the existing domain configuration Remember to update your DNS settings with your domain provider to point to the new GitBook configuration. The process is the same as the initial setup - you'll need to create a CNAME record pointing to the value GitBook provides. Last updated 3 months ago Was this helpful? --- # Why I am not receiving notifications? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send There can be several reasons why you may not be receiving notifications, which include but are not limited to: * Our email is in your spam folder or caught by another protection mechanism. * Emails sent to your email address from GitBook have bounced multiple times. As a result, our mail service has automatically blocked further sending. * There may be a temporary delivery issue that will be resolved by itself. * A wrong expectation about the notifications you should be receiving. * A notification has been sent to an email address different from the one you are currently checking. If you think you might be running into any of these issues, here are some things you can try: ### [](https://gitbook.com/docs/help-center/account-management/managing-your-account/why-i-am-not-receiving-notifications#check-if-you-havent-disabled-notifications-in-your-settings) Check if you haven't disabled notifications in your settings. Email notifications are enabled by default but can be disabled in [your notifications settings](https://app.gitbook.com/account/notification) . When enabled, GitBook will send one email per notification type. This will be sent to the email address associated with your personal GitBook account. Make sure you have enabled email notifications for the specific notification you want to receive. ### [](https://gitbook.com/docs/help-center/account-management/managing-your-account/why-i-am-not-receiving-notifications#check-your-spam-or-other-protection-mechanism) Check your spam or other protection mechanism Ensure that our email address (`no-reply@gitbook.io`) is not blocked on your end. ### [](https://gitbook.com/docs/help-center/account-management/managing-your-account/why-i-am-not-receiving-notifications#make-sure-you-are-checking-the-correct-email-address) Make sure you are checking the correct email address. Occasionally, users create multiple accounts with similar email addresses. To confirm if you are checking the correct email address, verify which email you have registered with in [your account settings](https://app.gitbook.com/account) . Last updated 1 year ago Was this helpful? --- # How can I publish a space? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send As of May 2024, spaces are now being published as part of a docs site and are not published in a standalone fashion anymore. When you're ready to publish a space, you can link it to an existing site or create a new site to publish it. This makes the separation between content and publishing clear. ### [](https://gitbook.com/docs/help-center/published-documentation/publishing/how-can-i-publish-a-space#how-to-publish-a-space-as-a-part-of-a-docs-site) How to publish a space as a part of a docs site? 1. Go to **Docs sites** 2. Click on **New site** 3. Name your site 4. If you already have a space you'd like to publish, click on **Link an existing space**. Otherwise, you can choose to create a new space. 5. Click the **Publish** button You can change the visibility of your site under the **Publishing settings.** **Ultimate** sites can use additional visibility options such as _share link_, _unlisted_ or _Authenticated Access_. Last updated 5 months ago Was this helpful? --- # Is GitBook SOC 2 certified? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Yes. Customers and prospects can request access to the audit report [here.](https://app.vanta.com/gitbook.com/trust/riuibmbkcopvbwgqxul01a) Last updated 11 months ago Was this helpful? --- # Why am I seeing “We couldn’t load the integration” in GitBook? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send If you see this message, the most common cause is an ad blocker or privacy extension preventing the integration from loading. How to fix it: 1. Temporarily disable your ad blocker or privacy extension and reload the page. 2. If you don’t want to disable it entirely, add GitBook (and the services it uses) to your extension’s allowlist. 3. Refresh the page to check if the integration loads correctly. Last updated 3 months ago Was this helpful? --- # Collections | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Collections are a way to group spaces together to make it easier for you to organize your content. With collections, you can: * organize your content by similar topics or ideas * manage space [permissions](https://gitbook.com/docs/account-management/member-management/permissions-and-inheritance) at scale by allowing you to override the organization-level defaults. ### [](https://gitbook.com/docs/creating-content/content-structure/collection#create-a-collection) Create a collection Click the **+** button next to the **Spaces** header in the sidebar to create a new collection. You can also create a collection or space within another collection from the collection’s main page. ### [](https://gitbook.com/docs/creating-content/content-structure/collection#move-a-collection) Move a collection You can move a collection by opening the **Actions menu** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=45b786a9&sv=2)![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FQ4IsWwmEEi5QM7PSXNsN%252Factions%2520-%2520dark.svg%3Falt%3Dmedia%26token%3Debff54f4-9825-4ab0-99bc-633e1c449371&width=300&dpr=4&quality=100&sign=7ea56dee&sv=2), selecting **Move collection to…** and choosing a destination. Alternatively, you can drag and drop collections in the sidebar to move or reorder them. You can move collections into other collections — or even to other organizations, if you have an [admin role](https://gitbook.com/docs/account-management/member-management/roles) in both. ### [](https://gitbook.com/docs/creating-content/content-structure/collection#nested-collections) Nested collections You can nest collections inside each other, creating a collection -> sub-collection -> space hierarchy. Open a collection and you can click **New collection** from the collection’s main page to create a sub-collection. To move one collection into another, click **Move collection to…** from the collection’s **Action menu** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=45b786a9&sv=2)![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FQ4IsWwmEEi5QM7PSXNsN%252Factions%2520-%2520dark.svg%3Falt%3Dmedia%26token%3Debff54f4-9825-4ab0-99bc-633e1c449371&width=300&dpr=4&quality=100&sign=7ea56dee&sv=2) and then choose its new location. Alternatively, you can drag and drop the collection to its new location. ### [](https://gitbook.com/docs/creating-content/content-structure/collection#how-to-delete-a-collection) How to delete a collection You can delete a collection by opening its **Actions menu** ![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F89MTSo5XRpPMVr1T0rxS%252Factions.svg%3Falt%3Dmedia%26token%3D2b5d001e-560a-4f29-8d22-de8163725ca1&width=300&dpr=4&quality=100&sign=45b786a9&sv=2)![The Actions menu icon in GitBook](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FQ4IsWwmEEi5QM7PSXNsN%252Factions%2520-%2520dark.svg%3Falt%3Dmedia%26token%3Debff54f4-9825-4ab0-99bc-633e1c449371&width=300&dpr=4&quality=100&sign=7ea56dee&sv=2) and selecting **Delete**. **Deleting a collection is final**, but spaces inside a deleted collection will move to the **Trash** and can be restored up to seven days after deletion. You can access the Trash from the bottom of the sidebar. Last updated 4 days ago Was this helpful? --- # How do I install the Intercom integration on my site? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Intercom integration allows you to display the intercom widget on your public sites. You can install the integration from the Docs site settings. ### [](https://gitbook.com/docs/help-center/integrations/existing-integrations/how-do-i-install-the-intercom-integration-on-my-site#install-the-intercom-integration-on-a-site) Install the Intercom integration on a site 1. Navigate to the **site** where you want the integration to be installed. 2. In the site menu, click on the **Integrations** button in the top right and click on the tab **Installable.** 3. Select the Intercom integration, click on the cog icon and press **Install and enable.** 4. Next, you will be redirected to the **Integrations** page to finish configuring your integration on the chosen site. You can test that the integration is running as expected by visiting your published content and creating a test conversation. Last updated 1 year ago Was this helpful? --- # How can I publish a site with multiple versions? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Multivariant content allows you to display different versions (or variants) of your documentation, for example, different language versions such as English and French or documentation for subsequent releases such as 2.0, 2.1 and 2.2. In the previous versions of GitBook, this was managed through collections. If you have been using GitBook before May 2024 your multi-variant collections were automatically migrated to multi-variant Sites. ### [](https://gitbook.com/docs/help-center/published-documentation/publishing/how-can-i-publish-a-site-with-multiple-versions#how-to-publish-a-new-multi-variant-site) How to publish a new multi-variant Site 1. Create a new site or click on a site which should host your multi-variant content 2. Review the already **Linked spaces** in the **Content** tab. 3. Click **+** to add a new variant. 4. Select the space you want to add as a new variant to your published site. **Billing:** A multi-variant site is counted as a single published site towards your bill. Was this helpful? --- # What's the difference between a space and a docs site? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send In GitBook, **space** is your primary content area, containing its own set of pages, assets, and historical revisions. It's where you create, edit, and manage your documentation. A **docs** **site**, on the other hand, is a newer concept designed to specifically handle the aspects of publishing and rendering that content. While spaces focus on content creation and storage, sites manage how that content is presented and accessed publicly, providing a clear division between content management and content delivery. Last updated 1 year ago Was this helpful? --- # Toolbar on published sites and site previews | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send When viewing your live docs site, you may see a toolbar appear at the bottom of the browser window. It provides quick access to useful options with a click: * Open the editor to view and edit your site’s content * Open your site’s settings in GitBook * Open your site’s customization settings * View your site’s insights The toolbar is **only visible to logged-in members of your GitBook organization**. Site visitors who are not members of your GitBook organization **will not see the toolbar**. You will also see a slightly different version of the toolbar when you [open a preview URL for your site](https://gitbook.com/docs/collaboration/change-requests#preview-a-change-request) from the GitBook app, allowing you to jump back into the app to add feedback or continue editing. #### [](https://gitbook.com/docs/resources/gitbook-ui/toolbar-on-published-sites-and-site-previews#when-does-the-toolbar-appear) When does the toolbar appear? You will see the toolbar in the following situations: * Viewing your live site while logged into GitBook * Previewing earlier versions of your site through your [version history](https://gitbook.com/docs/creating-content/version-control) * Previewing links for proposed changes, such as in a [change request](https://gitbook.com/docs/collaboration/change-requests) created in GitBook or a pull request created through [Git Sync](https://gitbook.com/docs/getting-started/git-sync/github-pull-request-preview) #### [](https://gitbook.com/docs/resources/gitbook-ui/toolbar-on-published-sites-and-site-previews#can-i-hide-the-toolbar) Can I hide the toolbar? Yes. By clicking the last button on the toolbar, you can choose between different options to change how the toolbar is displayed: 1. **Minimize:** This reduces the toolbar to a small orb. To expand it again, you only have to click it. 2. **Close for one session:** Fully removes the toolbar in the current tab until you close it. 3. **Don't show again:** Hides the toolbar and remembers your choice. You can restore the toolbar by clearing your browser’s local storage. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fo8cxPQCicYRqWQiOoney%252Fgitbook-ui-preview-toolbar%25402x.jpg%3Falt%3Dmedia%26token%3Dbe04ba1d-8b70-4561-b94f-c6d7516f29de&width=768&dpr=4&quality=100&sign=a1ab7931&sv=2) Last updated 1 month ago Was this helpful? --- # Setting up AWS Cognito | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This guide takes you through setting up a protected sign-in screen for your docs. Before going through this guide, make sure you’ve first gone through the process of [enabling authenticated access](https://gitbook.com/docs/publishing-documentation/authenticated-access/enabling-authenticated-access) . To setup your GitBook site with authenticated access using AWS Cognito, the process looks as follows: 1 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito#create-a-new-aws-cognito-application) Create a new AWS Cognito application Create an AWS Cognito application from your AWS dashboard. 2 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito#install-and-configure-the-aws-cognito-integration) Install and configure the AWS Cognito integration Install the AWS Cognito integration and add the required configuration. 3 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito#configure-aws-cognito-for-adaptive-content-optional) Configure AWS Cognito for adaptive content (optional) Configure AWS Cognito to work with adaptive content in GitBook. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito#create-a-new-aws-cognito-application-1) Create a new AWS Cognito application Go to your desired User Pool in Cognito, and click on App integration. Make a note of the Cognito domain, we will need it to configure the integration. Scroll to the bottom and click "Create app client". For the app type, select "Confidential client." Scroll down to Hosted UI settings. In allowed Callback URLs, enter the Callback URL you got from GitBook upon installing the integration on a space. Scroll further down to "OAuth 2.0 grant types"- make sure "Authorization code grant" is selected. For "OpenID connect scopes", make sure OpenID is selected. Scroll down and click "Create app client". Click on the created app client and make a note of the Client ID and Client Secret. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito#install-and-configure-the-aws-cognito-integration-1) Install and configure the AWS Cognito integration Navigate to integrations within the GitBook app, select authenticated access as the category, and install the AWS Cognito integration. ![A GitBook screenshot showing the AWS Cognito integration install screen](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FCZy21M4LIPwMVSxI3ec1%252FScreen%2520Shot%25202024-12-13%2520at%25203.37.39%2520PM.png%3Falt%3Dmedia%26token%3D4e31d496-04eb-4d00-ac45-011b543edfe4&width=768&dpr=4&quality=100&sign=89bb5759&sv=2) Once you've installed it on your site, go to configuration and make a note of the Callback URL right above the Save button. We will need it to set up Cognito. Open up the Cognito integration's configuration screen for the space you installed the integration on. It should look like the following image: ![A GitBook screenshot showing the AWS Cognito configuration screen](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252Fgy177CzFZiy6U4IntLUE%252FScreen%2520Shot%25202024-12-13%2520at%25203.41.57%2520PM.png%3Falt%3Dmedia%26token%3D3823d5cb-56e0-4e02-abd6-6d6d66cacf71&width=768&dpr=4&quality=100&sign=a52f0e16&sv=2) For Client ID, Cognito Domain, and Client Secret, paste in the values you got from Cognito. Hit Save. Now, in GitBook, close the integrations modal and click on the Manage site button. Navigate to **Audience**, select **Authenticated access**, and choose Cognito as the backend. Then, click **Update audience**. Go to the site’s screen and click **Publish**. The site is now published behind authenticated access controlled by your Auth0 application. To try it out, click on Visit. You will be asked to sign in with Cognito, which confirms that your site is published behind authenticated access using Auth0. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-aws-cognito#configure-aws-cognito-for-adaptive-content-optional-1) Configure AWS Cognito for adaptive content (optional) To leverage Adaptive Content with authenticated access in GitBook, you’ll need to configure your Amazon Cognito user pool to include custom claims in the ID token. This is typically done by creating a [Cognito Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html) —specifically a _Pre Token Generation_ Lambda—that returns a JSON payload overriding or appending custom claims. These claims might include user roles, subscription tiers, or any other metadata relevant to your content. Here’s an example of what that could look like: Copy export const handler = async (event, context) => { // Retrieve user attribute from event request const userAttributes = event.request.userAttributes; // Add additional claims to event response event.response = { "claimsAndScopeOverrideDetails": { "idTokenGeneration": {}, "accessTokenGeneration": { "claimsToAddOrOverride": { "products": ['api', 'sites', 'askAI'], "isBetaUser": true, "isAlphaUser": true, } } } }; // Return to Amazon Cognito context.done(null, event); }; ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FwwKLiRUOJ27tjJCPc1Vd%252FScreenshot%25202025-06-30%2520at%252017.31.23.png%3Falt%3Dmedia%26token%3Df015ad33-1e96-47d4-82a5-e3b259f55a0e&width=768&dpr=4&quality=100&sign=8e9c4a27&sv=2) Once added, these key-value pairs are included in the authentication token and passed to GitBook, allowing your site to dynamically adapt its content based on the authenticated user’s profile. Last updated 3 months ago Was this helpful? --- # How does GitBook handle SEO? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Thanks to the following features, your GitBook projects are SEO-friendly with little or no configuration on your end: Responsive design[](https://gitbook.com/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo#responsive-design) All content is suitable for mobile devices, tablets, laptops and desktops! The design for your published documentation will adapt based on the size of the device it is being viewed on. SEO-friendly content[](https://gitbook.com/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo#seo-friendly-content) * URLs are set based on each page’s title by default, but can be customized as you wish. * We avoid duplicate content through smart, canonical URLs. * The HTML title and Open Graph title are based on the page and space title. * The meta description and Open Graph description are based on the page description. * Alt text can be added to images, which is also very important for accessibility. * HTML sent to crawlers is pre-rendered (i.e. server-side), meaning that crawlers do not need JavaScript to index your content. Note that we _don’t_ generate keyword meta tags, because modern search engines do not use them to rank pages. This was [officially confirmed by Google](https://developers.google.com/search/blog/2009/09/google-does-not-use-keywords-meta-tag) in 2009. Sitemap[](https://gitbook.com/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo#sitemap) Provided that your space is published with a setting _other_ than [unlisted](https://github.com/GitbookIO/help-center/blob/main/published-documentation/publishing/broken-reference/README.md) , we automatically generate a sitemap based on your [table of contents](https://gitbook.com/docs/getting-started/overview#table-of-contents) . To locate the full sitemap that lists all pages in your site, go to the home page of your documentation and append `/sitemap-pages.xml` to the URL. For example: [gitbook.com/docs/sitemap-pages.xml](https://gitbook.com/docs/sitemap-pages.xml) . Custom domain[](https://gitbook.com/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo#custom-domain) If you prefer, you can [set a custom domain](https://github.com/GitbookIO/help-center/blob/main/published-documentation/publishing/broken-reference/README.md) for your documentation. (e.g. `docs.example.com` instead of `yourorganization.gitbook.io`) Caching & CDN[](https://gitbook.com/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo#caching-and-cdn) All published content is cached and served via our global CDN (content delivery network). This helps to improve performance, which is an important factor within SEO. Even with these great features, it could still take some time before your documentation is indexed by Google (and other search engines). Both we and you have no _direct_ control over this, but there are two things that you could do to help improve the chance of getting your content indexed more quickly: 1. Make sure that there are links to your GitBook space from other websites that have already been indexed by Google. As Google will return to re-index these sites from time to time, this increases the chance that they’ll find your space as a result of re-indexing one of these other sites. 2. Try [submitting your site to Google](https://developers.google.com/search/docs/advanced/crawling/ask-google-to-recrawl) , which essentially asks them to index it. For GitBook spaces, this will only be possible if you are using a [custom domain](https://github.com/GitbookIO/help-center/blob/main/published-documentation/publishing/broken-reference/README.md) for your space _and_ if you create a TXT DNS record to confirm ownership of the domain. ### [](https://gitbook.com/docs/help-center/published-documentation/publishing/how-does-gitbook-handle-seo#redirects) Redirects Moving your content to GitBook or changing its structure? Broken links can impact your SEO. [Read how to set up redirects in GitBook](https://github.com/GitbookIO/help-center/blob/main/published-documentation/publishing/broken-reference/README.md) . **Note:** Whenever you move or rename a page within GitBook, its canonical URL also changes. To keep your content accessible, GitBook automatically creates a [HTTP 301](https://en.wikipedia.org/wiki/HTTP_301) redirect from the old URL to the new one. Find out more about how automatic redirects work on [our redirects page](https://github.com/GitbookIO/help-center/blob/main/published-documentation/publishing/broken-reference/README.md) . Last updated 7 days ago Was this helpful? --- # Git Sync | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send [Git Sync status shows an unexpected error](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/git-sync-status-shows-an-unexpected-error) [​GitBook is not using my docs folder](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/gitbook-is-not-using-my-docs-folder) [GitBook is creating new markdown files](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/gitbook-is-creating-new-markdown-files) [​Nothing happens on GitBook after adding a new file to my repository](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/nothing-happens-on-gitbook-after-adding-a-new-file-to-my-repository) [My table of contents is not correctly structured](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/my-table-of-contents-is-not-correctly-structured) [Error when pushing to the repository with protected branch](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/error-when-pushing-to-the-repository-with-protected-branch) [Git Sync file size limitations](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/git-sync-file-size-limitations) [Why am I getting a Git authentication failed message?](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/why-am-i-getting-a-git-authentication-failed-message) [Does Git Sync also sync pull-requests?](https://gitbook.com/docs/help-center/integrations/existing-integrations/git-sync/does-git-sync-also-sync-pull-requests) Was this helpful? --- # Is there a limit on the documentation import size or number? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send The best way to import content into GitBook is via [GitSync](https://www.gitbook.com/solutions/git-sync) . This allows you to upload up to 5000 markdown pages. We do support other [import formats](https://gitbook.com/docs/content-editor/import) but the functionality is more limited. Currently we have the following limits for imported content: * The import feature allows a maximum of 20 pages to be uploaded simultaneously. * The maximum number of files that can be uploaded in a single import is limited to 20. ### [](https://gitbook.com/docs/help-center/editing-content/managing-your-content/is-there-a-limit-on-the-documentation-import-size-or-number#can-i-request-an-increase-in-the-import-limit) **Can I request an increase in the import limit?** Currently, we’re unable to provide increases in import limits. Last updated 6 months ago Was this helpful? --- # Does GitBook have a find and replace feature? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send While there isn't a way to globally find and replace all instances of a term across your GitBook content, if you use our Git Sync feature, you can more easily find all instances of a word and replace it. Once you merge these updates in GitHub or GitLab, the changes will be synced and reflected in your content. Last updated 11 months ago Was this helpful? --- # FAQs | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send **Q: If a section, page, or block is restricted with Adaptive Content, will it still appear in search results? A:** Search results only reflect the content that a user has access to. Any section, page, or block behind Adaptive Content will only be indexed and visible in search for users who meet the conditions to view it. **Q: Do JWT claim schemas support free-form strings? A:** Not yet. JWT claim schemas currently only support enums for string values. Free-form strings aren’t supported, so the only option is to define all required string values within an enum. **Q: Can Adaptive Content work with arrays in JWT claims?** **A:** No, arrays aren’t supported. A claim can only provide a single value, and it must be either a string (enum) or a boolean. If multiple values are needed, they must be transformed on the claims provider side (e.g., Azure, Okta). **Q: How do I test and debug Adaptive Content conditions?** Try these checks: * Case sensitivity: Property names are case-sensitive (e.g., `role` ≠ `Role`). * Data types: Boolean vs string mismatches (true vs "true") * Nesting: Incorrect property path in conditions * You can check the claims attached to a token on [https://www.jwt.io/](https://www.jwt.io/) . You should see your expected claims being passed with the token. Last updated 2 months ago Was this helpful? --- # SSO Members vs non-SSO | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Users who have created a GitBook account with an email used in your SAML Identity Provider, or joined your organization prior to the configuration of SAML, might see their login with SSO being blocked with a message prompting them to "_Log in with your existing credentials_": ### [](https://gitbook.com/docs/account-management/sso-and-saml/sso-members-vs-non-sso#origin-of-the-message-and-security-considerations) Origin of the message and security considerations The first principle of our SAML SSO implementation is security. If a user account has been created using an email address `bob@company.com`, and later on Bob attempts to log in with the company SAML, **GitBook cannot verify the integrity of the email address returned by the identity provider** and thus cannot authenticate them as the current account `bob@company.com`. To prevent the creation of two accounts associated with the `bob@company.com` email address, **GitBook indicates to the user that they should log in with their original account. The organization administrator, later on, decides how to handle the case**: By enabling SSO on a user account, an organization administrator indicates to GitBook that the relationship between the email address of the account and the profile in your SAML Identity Provider can be trusted. ### [](https://gitbook.com/docs/account-management/sso-and-saml/sso-members-vs-non-sso#remediations) Remediations When a user sees their SSO login not succeeding with the message "Log in with your existing credentials", actions can be taken by the organization administrator to authorize them. #### [](https://gitbook.com/docs/account-management/sso-and-saml/sso-members-vs-non-sso#if-the-user-account-is-already-a-member-of-the-organization) If the user account is already a member of the organization: * An organization administrator can enable SSO on your organization membership from the administration dashboard. Next time, the user account will be authorized to login into the organization using the SSO flow. or * The user can log in to their account using the credentials initially used to create the account. For example, by clicking on "Continue with email" to receive an email sign-in link. * SSO login will not be automatically enabled for this user, and an organization administrator has to enable it explicitly from the admin dashboard. #### [](https://gitbook.com/docs/account-management/sso-and-saml/sso-members-vs-non-sso#if-the-user-account-is-not-yet-a-member-of-the-organization) If the user account is not yet a member of the organization: * An organization administrator should add the user account to the organization by inviting their email address from the admin dashboard. The user account can then directly be enabled for SSO login. ### [](https://gitbook.com/docs/account-management/sso-and-saml/sso-members-vs-non-sso#enabling-sso-login-for-members) Enabling SSO login for members Organization administrators can enable SSO login for members by linking their accounts to SSO. Doing this indicates to GitBook that the user account can be trusted as being connected to the identity in your provider. Last updated 11 months ago Was this helpful? --- # Can I build my own integration? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Our integration platform is currently available to anyone with a GitBook account! Head to [our integrations page](https://www.gitbook.com/integrations) or visit our [developer documentation](https://developer.gitbook.com/) to learn more. Last updated 11 months ago Was this helpful? --- # What happens to my content if an account or organization is deleted? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send If your content was deleted as a result of deleting an organization, all content associated with that organization is also permanently removed. We are unable to restore any content that was deleted in this manner. There is **no turning back** if you or another administrator deletes an organization! [](https://gitbook.com/docs/help-center/account-management/managing-your-organization/what-happens-to-my-content-if-an-account-or-organization-is-deleted#can-i-restore-my-lost-or-deleted-space) **Can I restore my lost or deleted space?** -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If your missing content was deleted less than seven days ago, you may restore it from your **Trash**. ![](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2FUa3kTfM3iWAoECzM0u90%2Fblobs%2FHEQ18KJrdglRfXzVZb2T%2FCleanShot%25202024-02-06%2520at%252014.46.41%402x.png&width=768&dpr=4&quality=100&sign=2bde3c27&sv=2) Review and restore recently deleted spaces. We do not store content back-ups, so restoration is limited to this 7-day window. [](https://gitbook.com/docs/help-center/account-management/managing-your-organization/what-happens-to-my-content-if-an-account-or-organization-is-deleted#what-happens-to-my-content-if-my-account-is-deleted) **What happens to my content if my account is deleted?** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Deleting an account will result in the permanent deletion of all the data and files associated with it. This means if you're the only member in an organization, all content in your organization will also be deleted. If you recreate your account, the deleted content won't reappear. [](https://gitbook.com/docs/help-center/account-management/managing-your-organization/what-happens-to-my-content-if-an-account-or-organization-is-deleted#does-all-content-get-deleted-if-a-user-in-an-organization-deletes-their-account) **Does all content get deleted if a user in an organization deletes their account?** ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ If the account is the sole member of an organization, all of its content will be deleted. However, if the account was part of an organization with multiple members, any content within that organization, including contributions from the deleted account, will remain intact. Last updated 11 months ago Was this helpful? --- # What is a default space and how to change it? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send When your **Docs site** has multiple spaces linked to it , it is referred to as a multi-variant site. This allows you to publish different language versions or product versions under one domain. In your **Docs Sites** dashboard, under the **Spaces** section, you will see one of your spaces labeled as **Default**. This indicates that this space is the first one visitors see when they visit your URL. ### [](https://gitbook.com/docs/help-center/published-documentation/publishing/what-is-a-default-space-and-how-to-change-it#changing-the-default-site) Changing the default site To change the default space: 1. Navigate to the **Spaces** section of **site** settings. 2. Click on the option menu (three vertical dots) next to the space you want to designate as the default, and then select **Set as default space**. Last updated 1 year ago Was this helpful? --- # How can I access insights or analytics? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send To access your Docs site's insights, navigate to your chosen Docs site and scroll down to the **Insights** in the dashboard. You can read more about how we calculate the content scores and how you can export the most searched terms in [our documentation.](https://gitbook.com/docs/published-documentation/insights) Insights give you information on the content you've published and how it performs. It's split up between two sections — **user scores** and **search analytics**. To access your Docs site's insights, navigate to your chosen Docs site and scroll down to the **Insights** in the dashboard. You can read more about how we calculate the content scores and how you can export the most searched terms in [our documentation.](https://gitbook.com/docs/published-documentation/insights) Site insights are available as part of the Pro plan and Enterprise plan. To find out more, [visit our pricing page](https://www.gitbook.com/pricing) . #### [](https://gitbook.com/docs/help-center/published-documentation/publishing/how-can-i-access-insights-or-analytics#integrations) Integrations You can also integrate your Docs sites with Google Analytics, Heap, Plausible, Toucan Toco, Fathom, Hotjar, Segment, or PostHog to track traffic in your tool's dashboard. Last updated 6 months ago Was this helpful? --- # Setting up OIDC | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This guide takes you through setting up a protected sign-in screen for your docs. Before going through this guide, make sure you’ve first gone through the process of [enabling authenticated access](https://gitbook.com/docs/publishing-documentation/authenticated-access/enabling-authenticated-access) . To setup your GitBook site with authenticated access using OIDC, the process looks as follows: 1 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-oidc#create-a-new-application-with-your-identity-provider) Create a new application with your identity provider Create an application from your identity provider’s dashboard. 2 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-oidc#install-and-configure-the-oidc-integration) Install and configure the OIDC integration Install the Auth0 integration and add the required configuration. OIDC stands for OpenID Connect, and it's an identity layer built on top of OAuth. Many identity providers abide by OIDC, and GitBook's OIDC integration for authenticated access allows you to publish your space behind authenticated access, and access to the content is controlled by your Identity Provider Since this guide is a generic guide meant for all identity providers, some details may vary depending on your Identity Provider. For illustration purposes, we are using Google as the identity provider in this guide. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-oidc#create-a-new-application-with-your-identity-provider-1) Create a new application with your identity provider There are some things that you need to set up on your Identity Provider in order to get the integration to work. You need to create a new app inside your Identity Provider. Its type should be "Web Application." In Google, you create these under "API and Services", "Credentials", and then under "OAuth 2.0 Client IDs."\\ ![A screenshot showing creation of an OAuth client in an identity provider](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F8ra7t88ktqM7yX7w1l4m%252FScreen%2520Shot%25202024-05-15%2520at%252011.19.59%2520AM.png%3Falt%3Dmedia%26token%3Dbc1fbb59-5a36-47f8-985f-da9c743e3adb&width=768&dpr=4&quality=100&sign=cb013007&sv=2) Click on Create Credentials, select OAuth Client ID, select Web Application as the type, name it appropriately, and under Authorized Redirect URIs, enter the Callback URL you got from GitBook. Click Create. Make a note of the Client ID and Client Secret. We will need these to finish configuring of our integration in GitBook. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-oidc#install-and-configure-the-oidc-integration-1) Install and configure the OIDC integration Navigate to integrations within the GitBook app, select authenticated access as the category, and install the OIDC integration. Install the OIDC integration on your chosen docs site. ![A GitBook screenshot showing the OIDC integration installation](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FCZy21M4LIPwMVSxI3ec1%252FScreen%2520Shot%25202024-12-13%2520at%25203.37.39%2520PM.png%3Falt%3Dmedia%26token%3D4e31d496-04eb-4d00-ac45-011b543edfe4&width=768&dpr=4&quality=100&sign=89bb5759&sv=2) Once you've installed it on your site, go to configuration and make a note of the Callback URL right above the Save button. We may need it to set up the Identity Provider. Open up the OIDC integration's configuration screen for the space you installed the integration on. It should look like the following image ![A GitBook screenshot showing the OIDC configuration screen](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F04b2yAGjDIJQsA2aPIEO%252FScreen%2520Shot%25202024-12-13%2520at%25203.38.30%2520PM.png%3Falt%3Dmedia%26token%3De89e34c5-0e95-4547-a507-cc1d727b6ee5&width=768&dpr=4&quality=100&sign=c760b0b9&sv=2) For Client ID and Client Secret, paste in the values you got for your identity provider. Now, you will need to find the Authorization Endpoint and Access Token Endpoint for your Identity Provider. For Google, these are `https://accounts.google.com/o/oauth2/v2/auth` and `https://oauth2.googleapis.com/token` respectively. If you are not using Google, these endpoints will be different for you. Please look into the documentation of your identity provider to locate these endpoints For OAuth Scope, its value will be again be different depending on your Identity Provider. In case of Google, you can enter `openid`. Please look at the list of allowed scopes in your Identity Provider's documentation, and enter the value of the least permissive scope. We only use the Access Token to verify that the user is authenticated, and we do not use the Access Token to fetch any further information. So, entering the least permissive scope is the best security recommendation. Hit Save. Now, in GitBook, close the integrations modal and click on the Manage site button. Navigate to **Audience**, select **Authenticated access**, and choose OIDC as the backend. Then, click **Update audience**. Go to the site’s screen and click **Publish**. The site is now published behind authenticated access controlled by your Auth0 application. To try it out, click on Visit. You will be asked to sign in with OIDC, which confirms that your site is published behind authenticated access using Auth0. Last updated 5 months ago Was this helpful? --- # How do I change or replace the favicon for my docs site? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send To replace the favicon for your published docs site, head to the site’s dashboard, then click the **Customization** tab at the top of the screen. In the **Customization** menu’s General tab you’ll see a section called **Title & Icon**. Click the icon to open the palette. Here you can either choose an emoji from the picker, or upload your own image. **Note:** The icon will be displayed as a square on the page and in the site’s favicon. We recommend you choose a graphical icon with minimum dimensions of 132 x 132 pixels. Once you’ve chosen your icon, click **Save**. It may take a few minutes for your change to be reflected in your published docs. If you don’t see your new favicon after a few minutes, it may be because your browser has cached the old favicon. Try opening your docs site in a different browser. Last updated 8 months ago Was this helpful? --- # Setting up Okta | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send This guide takes you through setting up a protected sign-in screen for your docs. Before going through this guide, make sure you’ve first gone through the process of [enabling authenticated access](https://gitbook.com/docs/publishing-documentation/authenticated-access/enabling-authenticated-access) . To setup your GitBook site with authenticated access using Okta, the process looks as follows: 1 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-okta#create-a-new-okta-application) Create a new Okta application Create an Okta application from your Okta dashboard. 2 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-okta#install-and-configure-the-okta-integration) Install and configure the Okta integration Install the Okta integration and add the required configuration. 3 #### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-okta#configure-okta-for-adaptive-content-optional) Configure Okta for adaptive content (optional) Configure Okta to work with adaptive content in GitBook. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-okta#create-a-new-okta-application-1) Create a new Okta application First, sign in to Okta platform (the admin version) and create a new app integration (or use an existing one) by clicking the Applications button in the left sidebar. ![An Okta screenshot showing the create app integration screen](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252F8roQ3QDR5zsyFh2FoQS4%252FScreen%2520Shot%25202023-10-30%2520at%25201.32.55%2520PM.png%3Falt%3Dmedia%26token%3Ddc46f9f6-ec54-456f-ba7b-397477089e1a&width=768&dpr=4&quality=100&sign=3b4ec9e&sv=2) Click Create App Integration and select OIDC - OpenID Connect as the Sign-In method. And then select Web Application as the application type. ![An Okta screenshot showing the integration setup](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FqgFHYo6HOUGF8dUTFEJM%252FScreen%2520Shot%25202023-10-30%2520at%25201.39.15%2520PM.png%3Falt%3Dmedia%26token%3D0ac8e337-6082-4a28-b3df-33fa4e33dc0d&width=768&dpr=4&quality=100&sign=1232bb6f&sv=2) Name it appropriately and don't edit any other setting on that page. For assignments, choose the appropriate checkbox. Click Save. On the next screen, copy Client ID and Client Secret. Copy the Okta Domain right below your email address by clicking the dropdown in the top right. ![An Okta screenshot showing where to copy client credentials](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FJQWvrITuUlno737DbQKM%252FScreen%2520Shot%25202023-10-30%2520at%25204.52.14%2520PM.png%3Falt%3Dmedia%26token%3D82a63cfd-a1e6-4666-b132-30fc98e95c22&width=768&dpr=4&quality=100&sign=49de916e&sv=2) We will need these values to configure the Okta Integration. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-okta#install-and-configure-the-okta-integration-1) Install and configure the Okta integration Navigate to the Integrations tab in the site you want to publish and locate the Okta integration. ![A GitBook screenshot showing the site settings page](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FeFArORtsvAcvgwbDZNce%252FScreen%2520Shot%25202024-12-13%2520at%25203.21.30%2520PM.png%3Falt%3Dmedia%26token%3D199acbf6-3100-49af-886e-d2d09445f978&width=768&dpr=4&quality=100&sign=cf04a268&sv=2) Install the integration on your site. Upon installation on site, you will see a screen asking you enter the Client ID, Okta Domain, and Client Secret. ![A GitBook screenshot showing the Okta credentials modal](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FHrwQ0ASv1tD6kTZPVLMY%252FScreen%2520Shot%25202024-12-13%2520at%25203.34.37%2520PM.png%3Falt%3Dmedia%26token%3D0844c1db-14b8-415c-8d51-33d4618e900e&width=768&dpr=4&quality=100&sign=f8f95e4d&sv=2) For Client ID, Okta Domain (remove `https://`prefix, if any) and Client Secret, paste in the value you copied from Okta Dashboard. Click Save. Copy the URL displayed in the modal and enter it as a Sign-In redirect URI in Okta (as shown in the below screenshot). Hit Save. ![An Okta screenshot showing the sign-in redirect URI configuration](https://gitbook.com/docs/~gitbook/image?url=https%3A%2F%2F1050631731-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNkEGS7hzeqa35sMXQZ4X%252Fuploads%252FpPZlqJlE6koyHrWhSp8i%252FScreen%2520Shot%25202024-01-14%2520at%25207.55.08%2520PM.png%3Falt%3Dmedia%26token%3D99abc690-c82b-4974-9b5a-7ba6fbd11ed2&width=768&dpr=4&quality=100&sign=8979cb63&sv=2) Now, in GitBook, close the integrations modal and click on the Manage site button. Navigate to **Audience**, select **Authenticated access**, and choose Okta as the backend. Then, click **Update audience**. Go to the site’s screen and click **Publish**. The site is now published behind authenticated access controlled by your Auth0 application. To try it out, click on Visit. You will be asked to sign in with Okta, which confirms that your site is published behind authenticated access using Auth0. ### [](https://gitbook.com/docs/publishing-documentation/authenticated-access/setting-up-okta#configure-okta-for-adaptive-content-optional-1) Configure Okta for adaptive content (optional) To enable Adaptive Content in your GitBook site with authenticated access, you’ll need to configure your Okta application to include relevant user data as claims in the authentication token. Claims are key-value pairs embedded in the token sent to GitBook. These claims can be used to dynamically tailor documentation based on the user’s role, plan, location, or any other identifying attribute. Okta supports multiple types of claims: * **Standard Claims** These are common claims (like `email`, `name`, or `groups`) that may be included by default but often need to be explicitly added to your token configuration for consistent availability. * **Custom Claims** You can define custom claims in Okta using [custom user attributes](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-add-custom-user-attributes.htm) or expression-based logic. These allow you to pass highly specific values—like plan tier, account ID, or internal team flags. * **Groups as Claims** You can also pass Okta groups as claims, which is especially useful when defining audience segments like “enterprise users” or “beta testers.” These can be filtered and mapped in your authorization server’s claim configuration. To add or customize claims in Okta: 1. Open your Okta Admin Console. 2. Navigate to **Security > API > Authorization Servers**. 3. Edit the authorization server used for your GitBook site. 4. Under the **Claims** tab, add rules to include the desired claims in the token. 5. Make sure your GitBook site is reading and mapping those claims correctly. Once claims are being passed into GitBook, follow the steps in [Adapting your content](https://gitbook.com/docs/publishing-documentation/adaptive-content/adapting-your-content) to define what content should be shown to whom. Last updated 10 days ago Was this helpful? --- # Which authentication method should I use for Adaptive content? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send It depends on how you want to control access: * Need public + private content? → Use Signed Cookies * Simple personalization without auth? → Use URL Parameters * Entire site private? → Use Authenticated Access Integration * Already use feature flags? → Use Feature Flag provider Last updated 2 months ago Was this helpful? --- # Reference | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send Customizing GitBook Assistant allows you to integrate the assistant directly into your product or website, making it feel like a natural part of your product's experience. To do this, GitBook Assistant also exposes helper functions that further allow it to interact with your app. Using these methods to close, show, hide, or unload the assistant will help you integrate GitBook Assistant more seamlessly into your product's experience. ### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#main-functions) Main functions #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#show-the-widget) Show the widget Display the GitBook widget if it has been hidden. **Example:** Copy window.GitBook("show"); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#hide-the-widget) Hide the widget Hide the GitBook widget without unloading it. **Example:** Copy window.GitBook("hide"); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#open-the-window) Open the window Open the GitBook Assistant window. **Example:** Copy window.GitBook("open"); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#close-the-window) Close the window Close the GitBook Assistant window. **Example:** Copy window.GitBook("close"); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#toggle-the-window) Toggle the window Toggle the GitBook Assistant window open or closed. **Example:** Copy window.GitBook("toggle"); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#unload-the-widget) Unload the widget Completely remove the GitBook widget from your site. **Example:** Copy window.GitBook("unload"); ### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#navigation-functions) Navigation functions #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#window.gitbook-navigatetopage-path) `window.GitBook('navigateToPage', path)` Navigate to a specific page within your GitBook docs by its path. **Parameters:** * `path` (string): The path to the page you want to navigate to **Example:** Copy // Navigate to the getting started guide window.GitBook("navigateToPage", "/getting-started"); // Navigate to a specific API documentation page window.GitBook("navigateToPage", "/api/authentication"); // Navigate to FAQ section window.GitBook("navigateToPage", "/faq/billing"); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#window.gitbook-navigatetoassistant) `window.GitBook('navigateToAssistant')` Navigate directly to the GitBook Assistant interface. **Example:** Copy // Open the assistant chat window.GitBook("navigateToAssistant"); // You might use this in response to a button click document.getElementById("help-button").addEventListener("click", () => { window.GitBook("navigateToAssistant"); }); ### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#chat-functions) Chat Functions #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#window.gitbook-postusermessage-message) `window.GitBook('postUserMessage', message)` Post a message to the chat as if the user typed it. **Parameters:** * `message` (string): The message to post to the chat **Example:** Copy // Send a predefined message window.GitBook("postUserMessage", "How do I reset my password?"); // Send a message based on user action function askAboutBilling() { window.GitBook("postUserMessage", "I have questions about my billing"); } // Send a message with context const userPlan = "premium"; window.GitBook( "postUserMessage", `I'm on the ${userPlan} plan and need help with advanced features` ); #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#window.gitbook-clearchat) `window.GitBook('clearChat')` Clear all messages from the current chat session. **Example:** Copy // Clear the chat window.GitBook("clearChat"); // Clear chat and start fresh conversation function startNewConversation() { window.GitBook("clearChat"); window.GitBook("postUserMessage", "Hello, I need help with a new issue"); } // Clear chat when switching contexts document.getElementById("new-topic").addEventListener("click", () => { window.GitBook("clearChat"); window.GitBook("navigateToAssistant"); }); ### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#event-handling) Event handling #### [](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant/configuration/reference#window.gitbook-on-event-listener) `window.GitBook('on', event, listener)` Register an event listener for GitBook events. **Parameters:** * `event` (string): The event name to listen for * `listener` (function): The callback function to execute when the event occurs **Example:** Copy // Listen for page navigation window.GitBook("on", "navigate", (data) => { console.log("Navigated to:", data.path); // Update breadcrumbs or analytics }); // Listen for tool usage window.GitBook("on", "tool_used", (data) => { console.log("Tool used:", data.toolName); // Log tool usage for analytics }); Last updated 1 month ago Was this helpful? --- # How do I transfer an organization to a different account? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send You might create an organization under the wrong email address/GitBook account. ### [](https://gitbook.com/docs/help-center/account-management/managing-your-organization/how-do-i-transfer-an-organization-to-a-different-account#i-want-to-access-my-organization-with-my-different-email-address) I want to access my organization with _my_ different email address Suppose it's still you but just a different email address. In that case, we suggest that you change the email address of your current GitBook account instead—that way, you avoid having to add multiple users to an organization. To do that follow our guide below: ### [](https://gitbook.com/docs/help-center/account-management/managing-your-organization/how-do-i-transfer-an-organization-to-a-different-account#i-want-to-transfer-my-organization-to-a-different-user) I want to transfer my organization to a different user If that is the case, and you want to transfer that organization to a different user, you need to add that user account to the organization. All you need to do is add that new account/user to the organization. If you are an admin and add a new user, you could also remove any unnecessary members from the organization. Last updated 11 months ago Was this helpful? --- # Can I embed an iframe in GitBook? | Help Center | GitBook Documentation [Docs Agents are coming — a new way to ideate, plan, and ship docs.\ \ Join the waitlsit](https://www.gitbook.com/#docs-agents) GitBook Assistant GitBook Assistant Thinking... GitBook Assistant ##### Good night I'm here to help you with the docs. What is this page about?What should I read next?Can you give an example? Ctrli AI Based on your context Send GitBook doesn't support direct embedding of external content using an HTML `