diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..6febb43 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,22 @@ +# GitBook Format Documentation + +> This documentation is for GitBook version **{{ book.version }}** + +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). This documentation has been generated using GitBook. + +GitBook can output your content as a website ([customizable](themes.md) and [extensibles](plugins.md)) or as an ebook (PDF, ePub or Mobi). + +[GitBook.com](https://www.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://www.gitbook.com/editor). + +### 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). + +### FAQ + +There are questions that are asked quite often, [check this out before creating an issue](faq.md). + +### Contribute to this documentation + +You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/gitbook) by signaling issues or proposing changes. + |