⚠️ Deprecation warning:

As the efforts of the GitBook team are focused on the GitBook.com platform, the CLI is no longer under active development.
All content supported by the CLI are mostly supported by our GitBook.com / GitHub integration.
Content hosted on the legacy.gitbook.com will continue working until further notice. For differences with the new version, > check out our documentation.

Join our GitHub community to stay up to date with the latest news at GitBook.

GitBook

NPM version Linux Build Status Windows Build status Slack Status

GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: Learn Javascript.

You can publish and host books easily online using gitbook.com. A desktop editor is also available.

Stay updated by following @GitBookIO on Twitter or GitBook on Facebook.

Complete documentation is available at toolchain.gitbook.com.

Image

Getting started

GitBook can be used either on your computer for building local books or on legacy.gitbook.com for hosting them. To get started, check out the installation instructions in the documentation.

Usage examples

GitBook can be used to create book, public documentation, enterprise manual, thesis, research papers, etc.

You can find a list of real-world examples in the documentation.

Help and Support

We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at gitbook.com/contact or signal an issue on GitHub.

Features

Publish your book

The platform legacy.gitbook.com is like an "Heroku for books": you can create a book on it (public, or private) and update it using git push.

Licensing

GitBook is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

GitbookIO/gitbook

{
"props": {
"initialPayload": {
"allShortcutsEnabled": false,
"path": "/",
"repo": {
"id": 18280236,
"defaultBranch": "master",
"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": "master",
"listCacheKey": "v0:1603141250.0",
"canEdit": false,
"refType": "branch",
"currentOid": "e350f4d8fc4fb0dda3f492200c4ffa1e56672143"
},
"tree": {
"items": [
{
"name": ".github",
"path": ".github",
"contentType": "directory"
},
{
"name": "bin",
"path": "bin",
"contentType": "directory"
},
{
"name": "docs",
"path": "docs",
"contentType": "directory"
},
{
"name": "lib",
"path": "lib",
"contentType": "directory"
},
{
"name": "testing",
"path": "testing",
"contentType": "directory"
},
{
"name": ".editorconfig",
"path": ".editorconfig",
"contentType": "file"
},
{
"name": ".eslintignore",
"path": ".eslintignore",
"contentType": "file"
},
{
"name": ".eslintrc",
"path": ".eslintrc",
"contentType": "file"
},
{
"name": ".gitignore",
"path": ".gitignore",
"contentType": "file"
},
{
"name": ".travis.yml",
"path": ".travis.yml",
"contentType": "file"
},
{
"name": "AUTHORS.md",
"path": "AUTHORS.md",
"contentType": "file"
},
{
"name": "CHANGES.md",
"path": "CHANGES.md",
"contentType": "file"
},
{
"name": "LICENSE",
"path": "LICENSE",
"contentType": "file"
},
{
"name": "README.md",
"path": "README.md",
"contentType": "file"
},
{
"name": "appveyor.yml",
"path": "appveyor.yml",
"contentType": "file"
},
{
"name": "book.js",
"path": "book.js",
"contentType": "file"
},
{
"name": "package.json",
"path": "package.json",
"contentType": "file"
},
{
"name": "preview.png",
"path": "preview.png",
"contentType": "file"
}
],
"templateDirectorySuggestionUrl": null,
"readme": null,
"totalCount": 18,
"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,
"recentlyTouchedDataChannel": null,
"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/master.zip"
}
},
"newCodespacePath": "/codespaces/new?hide_repo_select=true&repo=18280236"
},
"popovers": {
"rename": null,
"renamedParentRepo": null
},
"commitCount": "2,379",
"overviewFiles": [
{
"displayName": "README.md",
"repoName": "gitbook",
"refName": "master",
"path": "README.md",
"preferredFileType": "readme",
"tabName": "README",
"richText": "<article class=\"markdown-body entry-content container-lg\" itemprop=\"text\"><blockquote>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-️-deprecation-warning\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" href=\"#️-deprecation-warning\"><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><g-emoji class=\"g-emoji\" alias=\"warning\">⚠️</g-emoji> Deprecation warning:</h2>\n<p dir=\"auto\">As the efforts of the GitBook team are focused on the <a href=\"https://www.gitbook.com\" rel=\"nofollow\">GitBook.com</a> platform, the CLI is no longer under active development.<br>\nAll content supported by the CLI are mostly supported by our <a href=\"https://docs.gitbook.com/getting-started/git-sync\" rel=\"nofollow\">GitBook.com / GitHub integration</a>.<br>\nContent hosted on the <a href=\"https://legacy.gitbook.com\" rel=\"nofollow\">legacy.gitbook.com</a> will continue working until further notice. For differences with the new version, &gt; check out our <a href=\"https://docs.gitbook.com/v2-changes/important-differences\" rel=\"nofollow\">documentation</a>.</p>\n<p dir=\"auto\">Join our <a href=\"https://github.com/GitbookIO/community\">GitHub community</a> to stay up to date with the latest news at GitBook.</p>\n</blockquote>\n<h1 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-gitbook\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" 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>GitBook</h1>\n<p dir=\"auto\"><a href=\"http://badge.fury.io/js/gitbook\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/a175693e114dccec339fa5b62027fc1af7c6fce0f81755c871edac028c5d4b79/68747470733a2f2f62616467652e667572792e696f2f6a732f676974626f6f6b2e737667\" alt=\"NPM version\" data-canonical-src=\"https://badge.fury.io/js/gitbook.svg\" style=\"max-width: 100%;\"></a>\n<a href=\"https://travis-ci.org/GitbookIO/gitbook\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/71cbadca9006839abcd001b42e6c18f96c9b437f34a4b228bda3dbf9c30c8ef2/68747470733a2f2f7472617669732d63692e6f72672f476974626f6f6b494f2f676974626f6f6b2e706e673f6272616e63683d6d6173746572\" alt=\"Linux Build Status\" data-canonical-src=\"https://travis-ci.org/GitbookIO/gitbook.png?branch=master\" style=\"max-width: 100%;\"></a>\n<a href=\"https://ci.appveyor.com/project/GitBook/gitbook\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/609874c595dde381cd415940604626c0642ed134c78cae9d1767fe233c0feedb/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f36336e6c666c7863776d6232707565363f7376673d74727565\" alt=\"Windows Build status\" data-canonical-src=\"https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true\" style=\"max-width: 100%;\"></a>\n<a href=\"https://slack.gitbook.com\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/256fd2a77d6b41a7911c5280330c5f61fcd54848d4af395405b80dd49d4e9870/68747470733a2f2f736c61636b2e676974626f6f6b2e636f6d2f62616467652e737667\" alt=\"Slack Status\" data-canonical-src=\"https://slack.gitbook.com/badge.svg\" style=\"max-width: 100%;\"></a></p>\n<p dir=\"auto\">GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: <a href=\"https://legacy.gitbook.com/book/GitBookIO/javascript\" rel=\"nofollow\">Learn Javascript</a>.</p>\n<p dir=\"auto\">You can publish and host books easily online using <a href=\"https://legacy.gitbook.com\" rel=\"nofollow\">gitbook.com</a>. A desktop editor is <a href=\"https://legacy.gitbook.com/editor\" rel=\"nofollow\">also available</a>.</p>\n<p dir=\"auto\">Stay updated by following <a href=\"https://twitter.com/GitBookIO\" rel=\"nofollow\">@GitBookIO</a> on Twitter or <a href=\"https://www.facebook.com/gitbookcom\" rel=\"nofollow\">GitBook</a> on Facebook.</p>\n<p dir=\"auto\">Complete documentation is available at <a href=\"http://toolchain.gitbook.com/\" rel=\"nofollow\">toolchain.gitbook.com</a>.</p>\n<p dir=\"auto\"><a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"https://camo.githubusercontent.com/fe9e3df0355f9766eee85dd1487d0286e7aacc33d60e8a13bcdc7560a27938fd/68747470733a2f2f7261772e6769746875622e636f6d2f476974626f6f6b494f2f676974626f6f6b2f6d61737465722f707265766965772e706e67\"><img src=\"https://camo.githubusercontent.com/fe9e3df0355f9766eee85dd1487d0286e7aacc33d60e8a13bcdc7560a27938fd/68747470733a2f2f7261772e6769746875622e636f6d2f476974626f6f6b494f2f676974626f6f6b2f6d61737465722f707265766965772e706e67\" alt=\"Image\" data-canonical-src=\"https://raw.github.com/GitbookIO/gitbook/master/preview.png\" style=\"max-width: 100%;\"></a></p>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-getting-started\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" 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>Getting started</h2>\n<p dir=\"auto\">GitBook can be used either on your computer for building local books or on legacy.gitbook.com for hosting them. To get started, check out <a href=\"/GitbookIO/gitbook/blob/master/docs/setup.md\">the installation instructions in the documentation</a>.</p>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-usage-examples\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" href=\"#usage-examples\"><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>Usage examples</h2>\n<p dir=\"auto\">GitBook can be used to create book, public documentation, enterprise manual, thesis, research papers, etc.</p>\n<p dir=\"auto\">You can find a <a href=\"/GitbookIO/gitbook/blob/master/docs/examples.md\">list of real-world examples</a> in the documentation.</p>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-help-and-support\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" href=\"#help-and-support\"><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>Help and Support</h2>\n<p dir=\"auto\">We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at <a href=\"https://legacy.gitbook.com/contact\" rel=\"nofollow\">gitbook.com/contact</a> or signal an issue on <a href=\"https://github.com/GitbookIO/gitbook\">GitHub</a>.</p>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-features\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" href=\"#features\"><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>Features</h2>\n<ul dir=\"auto\">\n<li>Write using <a href=\"http://toolchain.gitbook.com/syntax/markdown.html\" rel=\"nofollow\">Markdown</a> or <a href=\"http://toolchain.gitbook.com/syntax/asciidoc.html\" rel=\"nofollow\">AsciiDoc</a></li>\n<li>Output as a website or <a href=\"http://toolchain.gitbook.com/ebook.html\" rel=\"nofollow\">ebook (pdf, epub, mobi)</a></li>\n<li><a href=\"http://toolchain.gitbook.com/languages.html\" rel=\"nofollow\">Multi-Languages</a></li>\n<li><a href=\"http://toolchain.gitbook.com/lexicon.html\" rel=\"nofollow\">Lexicon / Glossary</a></li>\n<li><a href=\"http://toolchain.gitbook.com/ebook.html\" rel=\"nofollow\">Cover</a></li>\n<li><a href=\"http://toolchain.gitbook.com/templating/\" rel=\"nofollow\">Variables and Templating</a></li>\n<li><a href=\"http://toolchain.gitbook.com/templating/conrefs.html\" rel=\"nofollow\">Content References</a></li>\n<li><a href=\"http://toolchain.gitbook.com/plugins/\" rel=\"nofollow\">Plugins</a></li>\n<li><a href=\"https://github.com/GitbookIO/theme-default\">Beautiful default theme</a></li>\n</ul>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-publish-your-book\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" href=\"#publish-your-book\"><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>Publish your book</h2>\n<p dir=\"auto\">The platform <a href=\"https://legacy.gitbook.com/\" rel=\"nofollow\">legacy.gitbook.com</a> is like an \"Heroku for books\": you can create a book on it (public, or private) and update it using <strong>git push</strong>.</p>\n<h2 tabindex=\"-1\" dir=\"auto\"><a id=\"user-content-licensing\" class=\"anchor\" aria-hidden=\"true\" tabindex=\"-1\" href=\"#licensing\"><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>Licensing</h2>\n<p dir=\"auto\">GitBook is licensed under the Apache License, Version 2.0. See <a href=\"/GitbookIO/gitbook/blob/master/LICENSE\">LICENSE</a> for the full license text.</p>\n</article>",
"loaded": true,
"timedOut": false,
"errorMessage": null,
"headerInfo": {
"toc": [
{
"level": 2,
"text": "⚠️ Deprecation warning:",
"anchor": "️-deprecation-warning",
"htmlText": "⚠️ Deprecation warning:"
},
{
"level": 1,
"text": "GitBook",
"anchor": "gitbook",
"htmlText": "GitBook"
},
{
"level": 2,
"text": "Getting started",
"anchor": "getting-started",
"htmlText": "Getting started"
},
{
"level": 2,
"text": "Usage examples",
"anchor": "usage-examples",
"htmlText": "Usage examples"
},
{
"level": 2,
"text": "Help and Support",
"anchor": "help-and-support",
"htmlText": "Help and Support"
},
{
"level": 2,
"text": "Features",
"anchor": "features",
"htmlText": "Features"
},
{
"level": 2,
"text": "Publish your book",
"anchor": "publish-your-book",
"htmlText": "Publish your book"
},
{
"level": 2,
"text": "Licensing",
"anchor": "licensing",
"htmlText": "Licensing"
}
],
"siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2FGitbookIO%2Fgitbook"
}
},
{
"displayName": "LICENSE",
"repoName": "gitbook",
"refName": "master",
"path": "LICENSE",
"preferredFileType": "license",
"tabName": "Apache-2.0",
"richText": null,
"loaded": false,
"timedOut": false,
"errorMessage": null,
"headerInfo": {
"toc": null,
"siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2FGitbookIO%2Fgitbook"
}
}
],
"overviewFilesProcessingTime": 27.794184
}
},
"appPayload": {
"helpUrl": "https://docs.github.com",
"findFileWorkerPath": "/assets-cdn/worker/find-file-worker-32bb159cc57c.js",
"findInFileWorkerPath": "/assets-cdn/worker/find-in-file-worker-c6704d501c10.js",
"githubDevUrl": null,
"enabled_features": {
"code_nav_ui_events": false,
"copilot_conversational_ux": false,
"copilot_conversational_ux_embedding_update": false,
"copilot_popover_file_editor_header": false,
"copilot_smell_icebreaker_ux": true,
"copilot_workspace": false,
"codeview_firefox_inert": true
}
}
}
}
{
"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 *.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 objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: 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": "Mon, 26 Feb 2024 11:16:15 GMT",
"etag": "1262d6c76daca5593a8a65b4847af6ee",
"referrer-policy": "no-referrer-when-downgrade",
"server": "GitHub.com",
"set-cookie": "logged_in=no; Path=/; Domain=github.com; Expires=Wed, 26 Feb 2025 11:16:15 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": "DBD6:8FE4:19753D0:242968B:65DC72FF",
"x-xss-protection": "0"
}