52 lines
2.8 KiB
Markdown
52 lines
2.8 KiB
Markdown
GitBook
|
|
=======
|
|
|
|
[](http://badge.fury.io/js/gitbook)
|
|
[](https://travis-ci.org/GitbookIO/gitbook)
|
|
[](https://ci.appveyor.com/project/GitBook/gitbook)
|
|
[](https://slack.gitbook.com)
|
|
|
|
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](https://www.gitbook.com/book/GitBookIO/javascript).
|
|
|
|
You can publish and host books easily online using [gitbook.com](https://www.gitbook.com). A desktop editor is [also available](https://www.gitbook.com/editor).
|
|
|
|
Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
|
|
|
|
Complete documentation is available at [help.gitbook.com](http://help.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](docs/setup.md).
|
|
|
|
## 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](docs/examples.md) 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](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
|
|
|
|
## Features
|
|
|
|
* [Output as a website or ebook (pdf, epub, mobi)](http://help.gitbook.com/format/output.html)
|
|
* [Multi-Languages](http://help.gitbook.com/format/languages.html)
|
|
* [Glossary](http://help.gitbook.com/format/glossary.html)
|
|
* [Cover](http://help.gitbook.com/format/cover.html)
|
|
* [AsciiDoc Support](http://help.gitbook.com/format/asciidoc.html)
|
|
* [Variables and Templating](http://help.gitbook.com/format/templating.html)
|
|
* [Content References](http://help.gitbook.com/format/conrefs.html)
|
|
* [Plugins](http://help.gitbook.com/format/plugins.html)
|
|
* [Beautiful default theme](https://github.com/GitbookIO/theme-default)
|
|
|
|
## Publish your book
|
|
|
|
The platform [GitBook.com](https://www.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](LICENSE) for the full license text.
|