mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-21 01:53:26 +00:00
Guillaume Grossetie
60 lines
3.5 KiB
Markdown
60 lines
3.5 KiB
Markdown
[](https://www.gitbook.com)
|
|
|
|
<p align="center">A <em>modern</em> customizable documentation format and toolchain</p>
|
|
|
|
|
|
<p align="center"><a href="#features"><strong>Features</strong></a> · <a href="https://www.gitbook.com"><strong>Hosting</strong></a> · <a href="http://redux.js.org/"><strong>Example</strong></a> · <a href="https://www.gitbook.com/editor"><strong>Editor</strong></a> · <a href="https://toolchain.gitbook.com/"><strong>Documentation</strong></a> · <a href="./CONTRIBUTING.md"><strong>Contributing!</strong></a> · <a href="https://twitter.com/GitBookIO"><strong>Twitter</strong></a></p>
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
<img src="https://badge.fury.io/js/gitbook.svg" />
|
|
<a href="https://travis-ci.org/GitbookIO/gitbook"><img src="https://travis-ci.org/GitbookIO/gitbook.png?branch=master" /></a>
|
|
<a href="https://ci.appveyor.com/project/GitBook/gitbook"><img src="https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true" /></a>
|
|
<a href="https://slack.gitbook.com"><img src="https://slack.gitbook.com/badge.svg" /></a>
|
|
</p>
|
|
|
|
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](http://redux.js.org/).
|
|
|
|
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 [toolchain.gitbook.com](http://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](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
|
|
|
|
* Write using [Markdown](http://toolchain.gitbook.com/syntax/markdown.html) or [AsciiDoc](http://toolchain.gitbook.com/syntax/asciidoc.html)
|
|
* Output as a website or [ebook (pdf, epub, mobi)](http://toolchain.gitbook.com/ebook.html)
|
|
* [Multi-Languages](http://toolchain.gitbook.com/languages.html)
|
|
* [Lexicon / Glossary](http://toolchain.gitbook.com/lexicon.html)
|
|
* [Cover](http://toolchain.gitbook.com/ebook.html)
|
|
* [Variables and Templating](http://toolchain.gitbook.com/templating/)
|
|
* [Content References](http://toolchain.gitbook.com/templating/conrefs.html)
|
|
* [Plugins](http://toolchain.gitbook.com/plugins/)
|
|
* [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.
|