GitBook

Docs - Community - Developer Docs - Changelog - Bug reports

Documented on GitBook

Welcome to GitBook, the platform for managing technical knowledge for teams.

This repository contains the open-source code used to render GitBook's published content.

GitBook Open Published Site

Table of Contents

Getting Started

To run a local version of this project, please follow these simple steps.

Prerequisites

  • Node.js (Version: >=18.x)
  • Bun

Set up

  1. Clone the repo into a public GitHub repository. If you plan to distribute the code, keep the source code public to comply with GNU GPLv3. To clone in a private repository, acquire a commercial license.
git clone https://github.com/gitbookIO/gitbook.git
  1. Install the project's dependencies through Bun.
bun install
  1. Start your local development server.
bun dev

Then open the space in your web browser, using http://localhost:3000// (example: http://localhost:3000/docs.gitbook.com).

Other development commands

  • bun format: format the code
  • bun lint: lint the code

CI and testing

All pull-requests will be tested against both visual and performances testing to prevent regressions.

Contributing

GitBook's rendering engine is fully open-source and built on top of Next.js. Head to our contributing guide to learn more about the workflow on adding your first Pull Request.

Types of contributions

We encourage you to contribute to GitBook to help us build the best tool for documenting technical knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.

Translations

The GitBook UI is rendered using a set of translation files found in src/intl/translations. We welcome all additional translations for the UI.

Bugs

Encounter a bug or find an issue you'd like to fix? Helping us fix issues related to GitBook greatly improves the experience for everyone. Head to the issues section of this repository to learn more about the types of bugs you can already help out with.

Deployment

Warning

While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.

Looking to add a specific feature in GitBook? Head to our contributing guide to get started.

Self-hosting this project puts the responsibility of maintaining and merging future updates on you. We cannot guarantee support, maintenance, or updates to forked and self-hosted instances of this project.

We want to make it as easy as possible for our community to collaborate and push the future of GitBook, which is why we encourage you to contribute to our product directly instead of creating your own version.

This project allows you to self-host the rendering portion of your GitBook published content. Self-hosting has pros and cons.

On the pro side, you can customize the look and feel of your content, and better embed your documentation in your application.

On the con side, you become responsible for the reliability of your published site, and keeping the renderer up-to-date with the changes made to the GitBook platform.

License

Distributed under the GNU GPLv3 License.

If you plan to distribute the code, you must the source code public to comply with GNU GPLv3. To clone in a private repository, acquire a commercial license.

See LICENSE for more information.

Acknowledgements

GitBook wouldn't be possible without these projects:

Contributors

Legacy GitBook (Deprecated)

Our previous version of GitBook and it's CLI tool are now deprecated. You can still view the old repository and it's commits on this branch.

GitbookIO/gitbook

{
  "props": {
    "initialPayload": {
      "allShortcutsEnabled": false,
      "path": "/",
      "repo": {
        "id": 18280236,
        "defaultBranch": "main",
        "name": "gitbook",
        "ownerLogin": "GitbookIO",
        "currentUserCanPush": false,
        "isFork": false,
        "isEmpty": false,
        "createdAt": "2014-03-31T03:01:56.000Z",
        "ownerAvatar": "https://avatars.githubusercontent.com/u/7111340?v=4",
        "public": true,
        "private": false,
        "isOrgOwned": true
      },
      "currentUser": null,
      "refInfo": {
        "name": "main",
        "listCacheKey": "v0:1721990662.0",
        "canEdit": false,
        "refType": "branch",
        "currentOid": "e9fe3975bb368e7694617a23536418f8fb3841b2"
      },
      "tree": {
        "items": [
          {
            "name": ".changeset",
            "path": ".changeset",
            "contentType": "directory"
          },
          {
            "name": ".github",
            "path": ".github",
            "contentType": "directory"
          },
          {
            "name": ".vscode",
            "path": ".vscode",
            "contentType": "directory"
          },
          {
            "name": "assets",
            "path": "assets",
            "contentType": "directory"
          },
          {
            "name": "docs",
            "path": "docs",
            "contentType": "directory"
          },
          {
            "name": "packages",
            "path": "packages",
            "contentType": "directory"
          },
          {
            "name": "patches",
            "path": "patches",
            "contentType": "directory"
          },
          {
            "name": ".gitignore",
            "path": ".gitignore",
            "contentType": "file"
          },
          {
            "name": ".prettierignore",
            "path": ".prettierignore",
            "contentType": "file"
          },
          {
            "name": ".prettierrc.json",
            "path": ".prettierrc.json",
            "contentType": "file"
          },
          {
            "name": "LICENSE",
            "path": "LICENSE",
            "contentType": "file"
          },
          {
            "name": "README.md",
            "path": "README.md",
            "contentType": "file"
          },
          {
            "name": "bun.lockb",
            "path": "bun.lockb",
            "contentType": "file"
          },
          {
            "name": "package.json",
            "path": "package.json",
            "contentType": "file"
          },
          {
            "name": "turbo.json",
            "path": "turbo.json",
            "contentType": "file"
          }
        ],
        "templateDirectorySuggestionUrl": null,
        "readme": null,
        "totalCount": 15,
        "showBranchInfobar": false
      },
      "fileTree": null,
      "fileTreeProcessingTime": null,
      "foldersToFetch": [],
      "treeExpanded": false,
      "symbolsExpanded": false,
      "isOverview": true,
      "overview": {
        "banners": {
          "shouldRecommendReadme": false,
          "isPersonalRepo": false,
          "showUseActionBanner": false,
          "actionSlug": null,
          "actionId": null,
          "showProtectBranchBanner": false,
          "publishBannersInfo": {
            "dismissActionNoticePath": "/settings/dismiss-notice/publish_action_from_repo",
            "releasePath": "/GitbookIO/gitbook/releases/new?marketplace=true",
            "showPublishActionBanner": false
          },
          "interactionLimitBanner": null,
          "showInvitationBanner": false,
          "inviterName": null
        },
        "codeButton": {
          "contactPath": "/contact",
          "isEnterprise": false,
          "local": {
            "protocolInfo": {
              "httpAvailable": true,
              "sshAvailable": null,
              "httpUrl": "https://github.com/GitbookIO/gitbook.git",
              "showCloneWarning": null,
              "sshUrl": null,
              "sshCertificatesRequired": null,
              "sshCertificatesAvailable": null,
              "ghCliUrl": "gh repo clone GitbookIO/gitbook",
              "defaultProtocol": "http",
              "newSshKeyUrl": "/settings/ssh/new",
              "setProtocolPath": "/users/set_protocol"
            },
            "platformInfo": {
              "cloneUrl": "https://desktop.github.com",
              "showVisualStudioCloneButton": false,
              "visualStudioCloneUrl": "https://windows.github.com",
              "showXcodeCloneButton": false,
              "xcodeCloneUrl": "https://developer.apple.com",
              "zipballUrl": "/GitbookIO/gitbook/archive/refs/heads/main.zip"
            }
          },
          "newCodespacePath": "/codespaces/new?hide_repo_select=true&repo=18280236"
        },
        "popovers": {
          "rename": null,
          "renamedParentRepo": null
        },
        "commitCount": "535",
        "overviewFiles": [
          {
            "displayName": "README.md",
            "repoName": "gitbook",
            "refName": "main",
            "path": "README.md",
            "preferredFileType": "readme",
            "tabName": "README",
            "richText": "<article class=\"markdown-body entry-content container-lg\" itemprop=\"text\"><div class=\"markdown-heading\" dir=\"auto\"><h1 align=\"center\" tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">GitBook</h1><a id=\"user-content-gitbook\" class=\"anchor\" aria-label=\"Permalink: GitBook\" href=\"#gitbook\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p align=\"center\" dir=\"auto\">\n  <a href=\"https://docs.gitbook.com/\" rel=\"nofollow\">Docs</a> - <a href=\"https://github.com/GitbookIO/community\">Community</a> - <a href=\"https://developer.gitbook.com/\" rel=\"nofollow\">Developer Docs</a> - <a href=\"https://changelog.gitbook.com/\" rel=\"nofollow\">Changelog</a> - <a href=\"https://github.com/GitbookIO/gitbook/issues/new?assignees=&amp;labels=bug&amp;template=bug_report.md\">Bug reports</a> \n</p>\n<p align=\"center\" dir=\"auto\">\n  <a href=\"https://gitbook.com\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/b7d3b266db157e2a080ea62d366500d9ce7385e586f08164fdd3d41185c8b094/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6d6573736167653d446f63756d656e7465642532306f6e253230476974426f6f6b266c6f676f3d646174613a696d6167652f737667253262786d6c3b6261736536342c50484e325a79423361575230614430694e6a55694947686c6157646f644430694e6a556949485a705a58644362336739496a41674d4341324e5341324e5349675a6d6c7362443069626d39755a53496765473173626e4d39496d6830644841364c79393364336375647a4d7562334a6e4c7a49774d44417663335a6e496a344b50484268644767675a443069545449334c6a4d354e6a51674d7a4d754e6a63324e454d7a4d4334314d6a553149444d314c6a51344d6a51674d7a49754d446b674d7a59754d7a67314e43417a4d7934344d44677a49444d324c6a4d344e6a6c444d7a55754e5449324e53417a4e69347a4f44673049444d334c6a41354d6a59674d7a55754e4467344d6941304d4334794d6a513549444d7a4c6a59344e7a644d4e6a41754d546b784e4341794d6934794d544130517a59784c6a41354d6a63674d6a45754e6a6b794d6941324d5334324e446730494449774c6a637a4d5467674e6a45754e6a51344e4341784f5334324f544978517a59784c6a59304f4451674d5467754e6a55794e4341324d5334774f544933494445334c6a59354d6941324d4334784f544530494445334c6a45334d7a6c4d4e4441754d6a45334e7941314c6a59354d6a5131517a4d334c6a41344f4467674d7934344f544d344e69417a4e5334314d6a517a494449754f546b304e5463674d7a4d754f4441334f4341794c6a6b354e544930517a4d794c6a41354d5449674d6934354f5455354d53417a4d4334314d6a633149444d754f446b324e4449674d6a63754e4341314c6a59354e7a5130544445774c6a49794f544d674d5455754e5467314e554d784d4334784d4449674d5455754e6a55344f4341784d4334774d7a6730494445314c6a59354e5451674f5334354e7a6b774f4341784e5334334d7a4178517a51754d54457a4e7a45674d546b754d54597a4e7941774c6a51344f5467354d6941794e5334304d7a497a494441754e4451784e444d3449444d794c6a49794f445a444d4334304e4441354e4467674d7a49754d6a6b334d7941774c6a51304d446b304f43417a4d69347a4e7a4134494441754e4451774f54513449444d794c6a55784e7a5a444d4334304e4441354e4467674d7a49754e6a59304d7941774c6a51304d446b304f43417a4d6934334d7a6332494441754e4451784e444d3349444d794c6a67774e6a4e444d4334304f446b334f4455674d7a6b754e546b304f5341304c6a45774e545579494451314c6a67314e7a63674f5334354e6a41304e4341304f5334794f5452444d5441754d4445354e6941304f53347a4d6a6733494445774c6a41344d7a49674e446b754d7a59314e4341784d4334794d544179494451354c6a517a4f44644d4d6a41754f5459314f5341314e5334324e446733517a49334c6a497a4d7a49674e546b754d6a59334d79417a4d43347a4e6a5934494459784c6a41334e6a59674d7a4d754f4441344d5341324d5334774e7a6333517a4d334c6a49304f544d674e6a45754d4463344f5341304d43347a4f445179494455354c6a49334d5463674e4459754e6a557a4f5341314e5334324e546330544455344c6a41774f4341304f5334784d544978517a59784c6a45304e7a51674e4463754d7a41794d7941324d6934334d546378494451324c6a4d354e7a51674e6a4d754e546335494451304c6a6b774e545a444e6a51754e4451774f5341304d7934304d544d35494459304c6a51304d446b674e4445754e6a4179494459304c6a51304d446b674d7a63754f5463344e46597a4d4334354e7a6778517a59304c6a51304d446b674d6a6b754f5463794f4341324d7934344f545931494449354c6a41304e6a51674e6a4d754d4445344d6941794f4334314e54637a517a59794c6a45324f4451674d6a67754d44677a4f5341324d5334784d7a4931494449344c6a41354d5341324d4334794f446b78494449344c6a55334e54684d4d7a63754d4441334e4341304d5334354e546734517a4d314c6a51304e5451674e4449754f4455324e79417a4e4334324e6a517a4944517a4c6a4d774e5459674d7a4d754f4441334d7941304d79347a4d445535517a4d794c6a6b314d4449674e444d754d7a41324d69417a4d6934784e6a6735494451794c6a67314e7a63674d7a41754e6a41324d7941304d5334354e6a4133544445304c6a67304f4463674d7a49754f5445314e554d784e4334774e546b3049444d794c6a51324d6a51674d544d754e6a59304e79417a4d6934794d7a55354944457a4c6a4d304e7a63674d7a49754d546b31517a45794c6a59794e53417a4d6934784d444533494445784c6a6b7a4d4445674d7a49754e5441324e6941784d5334324e54513449444d7a4c6a45344d544e444d5445754e544d304d53417a4d7934304e7a6379494445784c6a557a4e6a55674d7a4d754f544d794d6941784d5334314e44453049444d304c6a67304d6a52444d5445754e54513149444d314c6a55784d6a51674d5445754e5451324f43417a4e5334344e446330494445784c6a59774f5451674d7a59754d5455314e6b4d784d5334334e446b3349444d324c6a67304e5459674d5449754d5445794e79417a4e7934304e7a4131494445794c6a59304d6a67674d7a63754f544d304d554d784d6934344e7a6b3149444d344c6a45304d5445674d544d754d5459354e69417a4f43347a4d4467314944457a4c6a633149444d344c6a59304d7a564d4d7a41754e546b334e4341304f43347a4e6a6379517a4d794c6a45324e4445674e446b754d6a63784e43417a4d6934354e446330494451354c6a63794d7a55674d7a4d754f4441334e5341304f5334334d6a4d33517a4d304c6a59324e7a63674e446b754e7a497a4f53417a4e5334304e54457a494451354c6a49334d6a4d674d7a63754d4445344e4341304f43347a4e6a6735544455334c6a59324f4451674d7a59754e4459314e454d314f4334794d444d3349444d324c6a45314e6a6b674e5467754e4463784e43417a4e6934774d444932494455344c6a59334d6a45674d7a59754d5445344e554d314f4334344e7a493349444d324c6a497a4e4455674e5467754f4463794e79417a4e6934314e444d30494455344c6a67334d6a63674d7a63754d5459784d3159304d43347a4d7a5931517a55344c6a67334d6a63674e4445754d6a51794e4341314f4334344e7a4933494451784c6a59354e5451674e5467754e6a55334d6941304d6934774e6a677a517a55344c6a51304d5467674e4449754e4451784d7941314f4334774e446b7a494451794c6a59324e7a55674e5463754d6a59304e4341304d7934784d546b35544451774c6a497a4d6a49674e5449754f544d34517a4d334c6a41354e6a59674e5451754e7a51314e43417a4e5334314d6a6734494455314c6a59304f5449674d7a4d754f4441334f5341314e5334324e446730517a4d794c6a41344e6a6b674e5455754e6a51334e69417a4d4334314d546b35494455304c6a63304d6a51674d6a63754d7a6732494455794c6a6b7a4d6a464d4d5445754e4455774f5341304d7934334d6a64444d5445754e4441774d7941304d7934324f546334494445784c6a4d334e5341304d7934324f444d79494445784c6a4d314d5451674e444d754e6a59354e454d344c6a41784d44497a494451784c6a63784e7941314c6a6b304f44553549444d344c6a45304e5445674e5334354d6a6b794e53417a4e4334794e7a5530517a55754f5449354d5449674d7a51754d6a5134494455754f5449354d5449674d7a51754d6a45344f4341314c6a6b794f54457949444d304c6a45324d4452574d7a45754d6a51314f454d314c6a6b794f544579494449354c6a45774f5455674e7934774e6a59344f5341794e7934784d7a5135494467754f5445314d544d674d6a59754d44597a4e6b4d784d4334314e44677a494449314c6a45784e6a6b674d5449754e5459794f4341794e5334784d545578494445304c6a45354e7a63674d6a59754d4455344e3077794e79347a4f54593049444d7a4c6a59334e6a52614969426d615778735053496a526a4a474e3059334969382b436a777663335a6e50676f3d266c6162656c436f6c6f723d35633563356326636f6c6f723d334638394131266c6162656c3d253230\" alt=\"Documented on GitBook\" data-canonical-src=\"https://img.shields.io/static/v1?message=Documented%20on%20GitBook&amp;logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iNjUiIGhlaWdodD0iNjUiIHZpZXdCb3g9IjAgMCA2NSA2NSIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTI3LjM5NjQgMzMuNjc2NEMzMC41MjU1IDM1LjQ4MjQgMzIuMDkgMzYuMzg1NCAzMy44MDgzIDM2LjM4NjlDMzUuNTI2NSAzNi4zODg0IDM3LjA5MjYgMzUuNDg4MiA0MC4yMjQ5IDMzLjY4NzdMNjAuMTkxNCAyMi4yMTA0QzYxLjA5MjcgMjEuNjkyMiA2MS42NDg0IDIwLjczMTggNjEuNjQ4NCAxOS42OTIxQzYxLjY0ODQgMTguNjUyNCA2MS4wOTI3IDE3LjY5MiA2MC4xOTE0IDE3LjE3MzlMNDAuMjE3NyA1LjY5MjQ1QzM3LjA4ODggMy44OTM4NiAzNS41MjQzIDIuOTk0NTcgMzMuODA3OCAyLjk5NTI0QzMyLjA5MTIgMi45OTU5MSAzMC41Mjc1IDMuODk2NDIgMjcuNCA1LjY5NzQ0TDEwLjIyOTMgMTUuNTg1NUMxMC4xMDIgMTUuNjU4OCAxMC4wMzg0IDE1LjY5NTQgOS45NzkwOCAxNS43MzAxQzQuMTEzNzEgMTkuMTYzNyAwLjQ4OTg5MiAyNS40MzIzIDAuNDQxNDM4IDMyLjIyODZDMC40NDA5NDggMzIuMjk3MyAwLjQ0MDk0OCAzMi4zNzA4IDAuNDQwOTQ4IDMyLjUxNzZDMC40NDA5NDggMzIuNjY0MyAwLjQ0MDk0OCAzMi43Mzc2IDAuNDQxNDM3IDMyLjgwNjNDMC40ODk3ODUgMzkuNTk0OSA0LjEwNTUyIDQ1Ljg1NzcgOS45NjA0NCA0OS4yOTRDMTAuMDE5NiA0OS4zMjg3IDEwLjA4MzIgNDkuMzY1NCAxMC4yMTAyIDQ5LjQzODdMMjAuOTY1OSA1NS42NDg3QzI3LjIzMzIgNTkuMjY3MyAzMC4zNjY4IDYxLjA3NjYgMzMuODA4MSA2MS4wNzc3QzM3LjI0OTMgNjEuMDc4OSA0MC4zODQyIDU5LjI3MTcgNDYuNjUzOSA1NS42NTc0TDU4LjAwOCA0OS4xMTIxQzYxLjE0NzQgNDcuMzAyMyA2Mi43MTcxIDQ2LjM5NzQgNjMuNTc5IDQ0LjkwNTZDNjQuNDQwOSA0My40MTM5IDY0LjQ0MDkgNDEuNjAyIDY0LjQ0MDkgMzcuOTc4NFYzMC45NzgxQzY0LjQ0MDkgMjkuOTcyOCA2My44OTY1IDI5LjA0NjQgNjMuMDE4MiAyOC41NTczQzYyLjE2ODQgMjguMDgzOSA2MS4xMzI1IDI4LjA5MSA2MC4yODkxIDI4LjU3NThMMzcuMDA3NCA0MS45NTg4QzM1LjQ0NTQgNDIuODU2NyAzNC42NjQzIDQzLjMwNTYgMzMuODA3MyA0My4zMDU5QzMyLjk1MDIgNDMuMzA2MiAzMi4xNjg5IDQyLjg1NzcgMzAuNjA2MyA0MS45NjA3TDE0Ljg0ODcgMzIuOTE1NUMxNC4wNTk0IDMyLjQ2MjQgMTMuNjY0NyAzMi4yMzU5IDEzLjM0NzcgMzIuMTk1QzEyLjYyNSAzMi4xMDE3IDExLjkzMDEgMzIuNTA2NiAxMS42NTQ4IDMzLjE4MTNDMTEuNTM0MSAzMy40NzcyIDExLjUzNjUgMzMuOTMyMiAxMS41NDE0IDM0Ljg0MjRDMTEuNTQ1IDM1LjUxMjQgMTEuNTQ2OCAzNS44NDc0IDExLjYwOTQgMzYuMTU1NkMxMS43NDk3IDM2Ljg0NTYgMTIuMTEyNyAzNy40NzA1IDEyLjY0MjggMzcuOTM0MUMxMi44Nzk1IDM4LjE0MTEgMTMuMTY5NiAzOC4zMDg1IDEzLjc1IDM4LjY0MzVMMzAuNTk3NCA0OC4zNjcyQzMyLjE2NDEgNDkuMjcxNCAzMi45NDc0IDQ5LjcyMzUgMzMuODA3NSA0OS43MjM3QzM0LjY2NzcgNDkuNzIzOSAzNS40NTEzIDQ5LjI3MjMgMzcuMDE4NCA0OC4zNjg5TDU3LjY2ODQgMzYuNDY1NEM1OC4yMDM3IDM2LjE1NjkgNTguNDcxNCAzNi4wMDI2IDU4LjY3MjEgMzYuMTE4NUM1OC44NzI3IDM2LjIzNDUgNTguODcyNyAzNi41NDM0IDU4Ljg3MjcgMzcuMTYxM1Y0MC4zMzY1QzU4Ljg3MjcgNDEuMjQyNCA1OC44NzI3IDQxLjY5NTQgNTguNjU3MiA0Mi4wNjgzQzU4LjQ0MTggNDIuNDQxMyA1OC4wNDkzIDQyLjY2NzUgNTcuMjY0NCA0My4xMTk5TDQwLjIzMjIgNTIuOTM4QzM3LjA5NjYgNTQuNzQ1NCAzNS41Mjg4IDU1LjY0OTIgMzMuODA3OSA1NS42NDg0QzMyLjA4NjkgNTUuNjQ3NiAzMC41MTk5IDU0Ljc0MjQgMjcuMzg2IDUyLjkzMjFMMTEuNDUwOSA0My43MjdDMTEuNDAwMyA0My42OTc4IDExLjM3NSA0My42ODMyIDExLjM1MTQgNDMuNjY5NEM4LjAxMDIzIDQxLjcxNyA1Ljk0ODU5IDM4LjE0NTEgNS45MjkyNSAzNC4yNzU0QzUuOTI5MTIgMzQuMjQ4IDUuOTI5MTIgMzQuMjE4OCA1LjkyOTEyIDM0LjE2MDRWMzEuMjQ1OEM1LjkyOTEyIDI5LjEwOTUgNy4wNjY4OSAyNy4xMzQ5IDguOTE1MTMgMjYuMDYzNkMxMC41NDgzIDI1LjExNjkgMTIuNTYyOCAyNS4xMTUxIDE0LjE5NzcgMjYuMDU4N0wyNy4zOTY0IDMzLjY3NjRaIiBmaWxsPSIjRjJGN0Y3Ii8+Cjwvc3ZnPgo=&amp;labelColor=5c5c5c&amp;color=3F89A1&amp;label=%20\" style=\"max-width: 100%;\"></a>\n  <a href=\"#\"><img src=\"https://camo.githubusercontent.com/d11a94f919c0d2ad0be9876e3f2e6bb3c21e2ea989f5db218f8beb2fe786f544/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e5f536f757263652de29da4efb88f2d4644413539393f\" data-canonical-src=\"https://img.shields.io/badge/Open_Source-❤️-FDA599?\" style=\"max-width: 100%;\"></a>\n  <a href=\"/GitbookIO/gitbook/blob/main/LICENSE\"><img src=\"https://camo.githubusercontent.com/5b7b8b924505e0f6fb54a4664aa958130af63b2374c6d5701988bf88e91b1395/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d474e555f47504c76332d463445323844\" data-canonical-src=\"https://img.shields.io/badge/License-GNU_GPLv3-F4E28D\" style=\"max-width: 100%;\"></a>\n  <a href=\"/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md\"><img src=\"https://camo.githubusercontent.com/ad1d6d47281641f8a082c9968be75281c9255bcd5e438fc797d31bdb5ce7e45c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f676974626f6f6b494f2f676974626f6f6b\" data-canonical-src=\"https://img.shields.io/github/contributors/gitbookIO/gitbook\" style=\"max-width: 100%;\"></a>\n  <a href=\"https://github.com/gitbookIO/gitbook/issues\"><img src=\"https://camo.githubusercontent.com/e9325759468987706c2fae12832197832f5b040b4b28ae25368dd4d9866e9d4f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f676974626f6f6b494f2f676974626f6f6b\" data-canonical-src=\"https://img.shields.io/github/issues/gitbookIO/gitbook\" style=\"max-width: 100%;\"></a>\n</p>\n<p align=\"center\" dir=\"auto\">Welcome to GitBook, the platform for managing technical knowledge for teams.</p>\n<p align=\"center\" dir=\"auto\">This repository contains the open-source code used to render GitBook's published content.</p>\n<p align=\"center\" dir=\"auto\">\n  <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"/GitbookIO/gitbook/blob/main/assets/published-site.png\"><img alt=\"GitBook Open Published Site\" src=\"/GitbookIO/gitbook/raw/main/assets/published-site.png\" style=\"max-width: 100%;\"></a>\n</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Table of Contents</h2><a id=\"user-content-table-of-contents\" class=\"anchor\" aria-label=\"Permalink: Table of Contents\" href=\"#table-of-contents\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<ul dir=\"auto\">\n<li><a href=\"#getting-started\">Getting Started</a></li>\n<li><a href=\"#contributing\">Contributing</a>\n<ul dir=\"auto\">\n<li><a href=\"#types-of-contributions\">Types of contributions</a></li>\n</ul>\n</li>\n<li><a href=\"#license\">Licensing</a></li>\n<li><a href=\"#acknowledgements\">Acknowledgements</a></li>\n<li><a href=\"#legacy-gitbook-deprecated\">Legacy GitBook</a></li>\n</ul>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Getting Started</h2><a id=\"user-content-getting-started\" class=\"anchor\" aria-label=\"Permalink: Getting Started\" href=\"#getting-started\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">To run a local version of this project, please follow these simple steps.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Prerequisites</h3><a id=\"user-content-prerequisites\" class=\"anchor\" aria-label=\"Permalink: Prerequisites\" href=\"#prerequisites\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<ul dir=\"auto\">\n<li>Node.js (Version: &gt;=18.x)</li>\n<li>Bun</li>\n</ul>\n<div class=\"markdown-heading\" dir=\"auto\"><h3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Set up</h3><a id=\"user-content-set-up\" class=\"anchor\" aria-label=\"Permalink: Set up\" href=\"#set-up\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<ol dir=\"auto\">\n<li>Clone the repo into a <strong>public</strong> GitHub repository. If you plan to distribute the code, keep the source code public to comply with GNU GPLv3. To clone in a private repository, acquire a <a href=\"https://www.gitbook.com/pricing\" rel=\"nofollow\">commercial license</a>.</li>\n</ol>\n<div class=\"snippet-clipboard-content notranslate position-relative overflow-auto\" data-snippet-clipboard-copy-content=\"git clone https://github.com/gitbookIO/gitbook.git\"><pre class=\"notranslate\"><code>git clone https://github.com/gitbookIO/gitbook.git\n</code></pre></div>\n<ol start=\"2\" dir=\"auto\">\n<li>Install the project's dependencies through Bun.</li>\n</ol>\n<div class=\"snippet-clipboard-content notranslate position-relative overflow-auto\" data-snippet-clipboard-copy-content=\"bun install\"><pre class=\"notranslate\"><code>bun install\n</code></pre></div>\n<ol start=\"3\" dir=\"auto\">\n<li>Start your local development server.</li>\n</ol>\n<div class=\"snippet-clipboard-content notranslate position-relative overflow-auto\" data-snippet-clipboard-copy-content=\"bun dev\"><pre class=\"notranslate\"><code>bun dev\n</code></pre></div>\n<p dir=\"auto\">Then open the space in your web browser, using <a href=\"http://localhost:3000/\" rel=\"nofollow\">http://localhost:3000/</a>/ (example: <a href=\"http://localhost:3000/docs.gitbook.com\" rel=\"nofollow\">http://localhost:3000/docs.gitbook.com</a>).</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Other development commands</h3><a id=\"user-content-other-development-commands\" class=\"anchor\" aria-label=\"Permalink: Other development commands\" href=\"#other-development-commands\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<ul dir=\"auto\">\n<li><code>bun format</code>: format the code</li>\n<li><code>bun lint</code>: lint the code</li>\n</ul>\n<div class=\"markdown-heading\" dir=\"auto\"><h3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">CI and testing</h3><a id=\"user-content-ci-and-testing\" class=\"anchor\" aria-label=\"Permalink: CI and testing\" href=\"#ci-and-testing\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">All pull-requests will be tested against both visual and performances testing to prevent regressions.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Contributing</h2><a id=\"user-content-contributing\" class=\"anchor\" aria-label=\"Permalink: Contributing\" href=\"#contributing\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">GitBook's rendering engine is fully open-source and built on top of <a href=\"https://nextjs.org/\" rel=\"nofollow\">Next.js</a>. Head to our <a href=\"https://github.com/GitbookIO/gitbook/.github/CONTRIBUTING.md\">contributing guide</a> to learn more about the workflow on adding your first Pull Request.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Types of contributions</h3><a id=\"user-content-types-of-contributions\" class=\"anchor\" aria-label=\"Permalink: Types of contributions\" href=\"#types-of-contributions\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">We encourage you to contribute to GitBook to help us build the best tool for documenting technical knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h4 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Translations</h4><a id=\"user-content-translations\" class=\"anchor\" aria-label=\"Permalink: Translations\" href=\"#translations\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">The GitBook UI is rendered using a set of translation files found in <a href=\"/GitbookIO/gitbook/blob/main/src/intl/translations\"><code>src/intl/translations</code></a>. We welcome all additional translations for the UI.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h4 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Bugs</h4><a id=\"user-content-bugs\" class=\"anchor\" aria-label=\"Permalink: Bugs\" href=\"#bugs\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">Encounter a bug or find an issue you'd like to fix? Helping us fix issues related to GitBook greatly improves the experience for everyone. Head to the issues section of this repository to learn more about the types of bugs you can already help out with.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Deployment</h2><a id=\"user-content-deployment\" class=\"anchor\" aria-label=\"Permalink: Deployment\" href=\"#deployment\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<div class=\"markdown-alert markdown-alert-warning\" dir=\"auto\"><p class=\"markdown-alert-title\" dir=\"auto\"><svg class=\"octicon octicon-alert mr-2\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p><p dir=\"auto\">While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.</p>\n<p dir=\"auto\"><em>Looking to add a specific feature in GitBook? Head to our <a href=\"/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md\">contributing guide</a> to get started.</em></p>\n<p dir=\"auto\">Self-hosting this project puts the responsibility of maintaining and merging future updates on <strong>you</strong>. We cannot guarantee support, maintenance, or updates to forked and self-hosted instances of this project.</p>\n<p dir=\"auto\">We want to make it as easy as possible for our community to collaborate and push the future of GitBook, which is why we encourage you to contribute to our product directly instead of creating your own version.</p>\n</div>\n<p dir=\"auto\">This project allows you to self-host the rendering portion of your GitBook published content. Self-hosting has pros and cons.</p>\n<p dir=\"auto\">On the pro side, you can customize the look and feel of your content, and better embed your documentation in your application.</p>\n<p dir=\"auto\">On the con side, you become responsible for the reliability of your published site, and keeping the renderer up-to-date with the changes made to the GitBook platform.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">License</h2><a id=\"user-content-license\" class=\"anchor\" aria-label=\"Permalink: License\" href=\"#license\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">Distributed under the <a href=\"https://github.com/GitBookIO/gitbook/blob/main/LICENSE\">GNU GPLv3 License</a>.</p>\n<p dir=\"auto\">If you plan to distribute the code, you must the source code public to comply with GNU GPLv3. To clone in a private repository, acquire a <a href=\"https://www.gitbook.com/pricing\" rel=\"nofollow\">commercial license</a>.</p>\n<p dir=\"auto\">See <code>LICENSE</code> for more information.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Acknowledgements</h2><a id=\"user-content-acknowledgements\" class=\"anchor\" aria-label=\"Permalink: Acknowledgements\" href=\"#acknowledgements\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">GitBook wouldn't be possible without these projects:</p>\n<ul dir=\"auto\">\n<li><a href=\"https://nextjs.org/\" rel=\"nofollow\">Next.js</a></li>\n<li><a href=\"https://bun.sh/\" rel=\"nofollow\">Bun</a></li>\n<li><a href=\"https://tailwindcss.com/\" rel=\"nofollow\">Tailwind CSS</a></li>\n<li><a href=\"https://www.npmjs.com/package/framer-motion\" rel=\"nofollow\">Framer Motion</a></li>\n</ul>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Contributors</h2><a id=\"user-content-contributors\" class=\"anchor\" aria-label=\"Permalink: Contributors\" href=\"#contributors\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<a href=\"https://github.com/gitbookIO/gitbook/graphs/contributors\">\n  <img src=\"https://camo.githubusercontent.com/505c3970f6a92ebf34d7702c4bc0b84200713518ea220e4cc62cd4e260dc5449/68747470733a2f2f636f6e747269622e726f636b732f696d6167653f7265706f3d676974626f6f6b494f2f676974626f6f6b\" data-canonical-src=\"https://contrib.rocks/image?repo=gitbookIO/gitbook\" style=\"max-width: 100%;\">\n</a>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Legacy GitBook (Deprecated)</h2><a id=\"user-content-legacy-gitbook-deprecated\" class=\"anchor\" aria-label=\"Permalink: Legacy GitBook (Deprecated)\" href=\"#legacy-gitbook-deprecated\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">Our previous version of GitBook and it's CLI tool are now deprecated. You can still view the old repository and it's commits on this <a href=\"https://github.com/GitbookIO/gitbook/tree/legacy\">branch</a>.</p>\n</article>",
            "loaded": true,
            "timedOut": false,
            "errorMessage": null,
            "headerInfo": {
              "toc": [
                {
                  "level": 1,
                  "text": "GitBook",
                  "anchor": "gitbook",
                  "htmlText": "GitBook"
                },
                {
                  "level": 2,
                  "text": "Table of Contents",
                  "anchor": "table-of-contents",
                  "htmlText": "Table of Contents"
                },
                {
                  "level": 2,
                  "text": "Getting Started",
                  "anchor": "getting-started",
                  "htmlText": "Getting Started"
                },
                {
                  "level": 3,
                  "text": "Prerequisites",
                  "anchor": "prerequisites",
                  "htmlText": "Prerequisites"
                },
                {
                  "level": 3,
                  "text": "Set up",
                  "anchor": "set-up",
                  "htmlText": "Set up"
                },
                {
                  "level": 3,
                  "text": "Other development commands",
                  "anchor": "other-development-commands",
                  "htmlText": "Other development commands"
                },
                {
                  "level": 3,
                  "text": "CI and testing",
                  "anchor": "ci-and-testing",
                  "htmlText": "CI and testing"
                },
                {
                  "level": 2,
                  "text": "Contributing",
                  "anchor": "contributing",
                  "htmlText": "Contributing"
                },
                {
                  "level": 3,
                  "text": "Types of contributions",
                  "anchor": "types-of-contributions",
                  "htmlText": "Types of contributions"
                },
                {
                  "level": 4,
                  "text": "Translations",
                  "anchor": "translations",
                  "htmlText": "Translations"
                },
                {
                  "level": 4,
                  "text": "Bugs",
                  "anchor": "bugs",
                  "htmlText": "Bugs"
                },
                {
                  "level": 2,
                  "text": "Deployment",
                  "anchor": "deployment",
                  "htmlText": "Deployment"
                },
                {
                  "level": 2,
                  "text": "License",
                  "anchor": "license",
                  "htmlText": "License"
                },
                {
                  "level": 2,
                  "text": "Acknowledgements",
                  "anchor": "acknowledgements",
                  "htmlText": "Acknowledgements"
                },
                {
                  "level": 2,
                  "text": "Contributors",
                  "anchor": "contributors",
                  "htmlText": "Contributors"
                },
                {
                  "level": 2,
                  "text": "Legacy GitBook (Deprecated)",
                  "anchor": "legacy-gitbook-deprecated",
                  "htmlText": "Legacy GitBook (Deprecated)"
                }
              ],
              "siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2FGitbookIO%2Fgitbook"
            }
          },
          {
            "displayName": "LICENSE",
            "repoName": "gitbook",
            "refName": "main",
            "path": "LICENSE",
            "preferredFileType": "license",
            "tabName": "GPL-3.0",
            "richText": null,
            "loaded": false,
            "timedOut": false,
            "errorMessage": null,
            "headerInfo": {
              "toc": null,
              "siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2FGitbookIO%2Fgitbook"
            }
          }
        ],
        "overviewFilesProcessingTime": 0
      }
    },
    "appPayload": {
      "helpUrl": "https://docs.github.com",
      "findFileWorkerPath": "/assets-cdn/worker/find-file-worker-1583894afd38.js",
      "findInFileWorkerPath": "/assets-cdn/worker/find-in-file-worker-3a63a487027b.js",
      "githubDevUrl": null,
      "enabled_features": {
        "code_nav_ui_events": false,
        "overview_shared_code_dropdown_button": false,
        "react_blob_overlay": false,
        "copilot_conversational_ux_embedding_update": false,
        "copilot_smell_icebreaker_ux": true,
        "copilot_workspace": false
      }
    }
  }
}
{
  "accept-ranges": "bytes",
  "cache-control": "max-age=0, private, must-revalidate",
  "content-encoding": "gzip",
  "content-security-policy": "default-src 'none'; base-uri 'self'; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com api.githubcopilot.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com/v1/engines/github-completion/completions proxy.enterprise.githubcopilot.com/v1/engines/github-completion/completions *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/",
  "content-type": "text/html; charset=utf-8",
  "date": "Sat, 27 Jul 2024 08:50:46 GMT",
  "etag": "1cbdca36480d716ecea8ca02565ccc6c",
  "referrer-policy": "no-referrer-when-downgrade",
  "server": "GitHub.com",
  "set-cookie": "logged_in=no; Path=/; Domain=github.com; Expires=Sun, 27 Jul 2025 08:50:46 GMT; HttpOnly; Secure; SameSite=Lax",
  "strict-transport-security": "max-age=31536000; includeSubdomains; preload",
  "transfer-encoding": "chunked",
  "vary": "X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, Accept-Encoding, Accept, X-Requested-With",
  "x-content-type-options": "nosniff",
  "x-frame-options": "deny",
  "x-github-request-id": "9FA2:1827:1050BF4:150AECC:66A4B4E6",
  "x-xss-protection": "0"
}