node package manager

gitbook

Library and cmd utility to generate GitBooks

GitBook

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.

Check out the GitBook Community Slack Channel, Stay updated by following @GitBookIO on Twitter or GitBook on Facebook.

Complete documentation is available at toolchain.gitbook.com.

Getting started

GitBook can be used either on your computer for building local books or on 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 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.

Private packages for the whole team

It’s never been easier to manage developer teams with varying permissions and multiple projects. Learn more about Private Packages and Organizations…

how? learn more

Collaborators

Stats

Try it out

Keywords

gitbook, book, git

Dependencies (51)

urijs, tmp, tiny-lr, spawn-cmd, send, semver, rmdir, resolve, request, read-installed, q, open, omit-keys, object-path, nunjucks-do, nunjucks, npmi, npm, moment, mkdirp, juice, jsonschema, json-schema-defaults, js-yaml, is, immutable, ignore, i18n-t, graceful-fs, github-slugid, gitbook-plugin-theme-default, gitbook-plugin-sharing, gitbook-plugin-search, gitbook-plugin-lunr, gitbook-plugin-livereload, gitbook-plugin-highlight, gitbook-plugin-fontsettings, gitbook-markdown, gitbook-asciidoc, front-matter, fresh-require, extend, escape-string-regexp, escape-html, error, dom-serializer, direction, destroy, crc, cpr, and 4 more

Dependents

componently, @zambezi/ez-doc, gitbook-plugin-plasma, gitbook2edx, febook, grunt-gitbook-install, grunt-gitbook, generator-gitbook-base