gitbook 0,7,17,27,13,0,23,0 editorconfig eslint travis-ci npm

2 years after Apache-2.0

GitBook

A modern customizable documentation format and toolchain

Features · Hosting · Example · Editor · Documentation · Contributing! · Twitter


Preview

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: ReduxJS documentation.

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.

Related Repositories

gitbook-cli

gitbook-cli

GitBook's command line interface ...

gitbook-zh

gitbook-zh

gitbook ...

gitbook-server

gitbook-server

GitBook server in docker container ...

gitbook-convert

gitbook-convert

CLI to convert an existing document to a GitBook. ...

gitbook-plugin-edit-link

gitbook-plugin-edit-link

GitBook Plugin to add "Edit with Github (or Gitlab)" link on every page ...


Top Contributors

SamyPesse AaronO jpreynat Soreine mrpotes davidagraf shaform aschempp citizenmatt codepiano rlmv erixtekila embreinhardt egasato howiehu nghong jr0cket bebraw iamolivinius tcorral frodsan dylang ianmcburnie jashaj JozoVilcek mjanda mpfeil MHM5000 RyanOM deminoth

Dependencies

package version
bash-color 0.0.4
cheerio 0.20.0
chokidar 1.5.0
cp 0.2.0
cpr 1.1.1
crc 3.4.0
destroy 1.0.4
direction 0.1.5
dom-serializer 0.1.0
error 7.0.2
escape-html ^1.0.3
escape-string-regexp 1.0.5
extend ^3.0.0
fresh-require 1.0.3
front-matter ^2.1.0
gitbook-asciidoc 1.2.2
gitbook-markdown 1.3.2
gitbook-plugin-fontsettings 2.0.0
gitbook-plugin-highlight 2.0.2
gitbook-plugin-livereload 0.0.1
gitbook-plugin-lunr 1.2.0
gitbook-plugin-search 2.2.1
gitbook-plugin-sharing 1.0.2
gitbook-plugin-theme-default 1.0.7
github-slugid 1.0.1
graceful-fs 4.1.4
i18n-t 1.0.1
ignore 3.1.2
immutable ^3.8.1
is ^3.1.0
js-yaml ^3.6.1
json-schema-defaults 0.1.1
jsonschema 1.1.0
juice 2.0.0
mkdirp 0.5.1
moment 2.13.0
npm 3.9.2
npmi 2.0.1
nunjucks 2.5.2
nunjucks-do 1.0.0
object-path ^0.9.2
omit-keys ^0.1.0
open 0.0.5
q 1.4.1
read-installed ^4.0.3
request 2.72.0
resolve 1.1.7
rmdir 1.2.0
semver 5.1.0
send 0.13.2
spawn-cmd 0.0.2
tiny-lr 0.2.1
tmp 0.0.28
urijs 1.18.0
dev eslint 2.10.2
expect ^1.20.1
mocha ^2.4.5

Releases

-   3.2.0 zip tar
-   3.2.0-pre.1 zip tar
-   3.2.0-pre.0 zip tar
-   3.1.1 zip tar
-   3.1.0 zip tar
-   3.0.3 zip tar
-   3.0.2 zip tar
-   3.0.1 zip tar
-   3.0.0 zip tar
-   3.0.0-pre.15 zip tar
-   3.0.0-pre.14 zip tar
-   3.0.0-pre.13 zip tar
-   3.0.0-pre.12 zip tar
-   3.0.0-pre.11 zip tar
-   3.0.0-pre.10 zip tar
-   3.0.0-pre.9 zip tar
-   3.0.0-pre.8 zip tar
-   3.0.0-pre.7 zip tar
-   3.0.0-pre.6 zip tar
-   3.0.0-pre.5 zip tar
-   3.0.0-pre.4 zip tar
-   3.0.0-pre.3 zip tar
-   3.0.0-pre.2 zip tar
-   3.0.0-pre.1 zip tar
-   2.6.7 zip tar
-   2.6.6 zip tar
-   2.6.5 zip tar
-   2.6.4 zip tar
-   2.6.3 zip tar
-   2.6.2 zip tar