Changes in this fork (published as
- no dependency on heavy-weight
npmto install required plugins.
lib/cli/build.jsto build book for web. No need to use globally installed
gitbook-cli. You can simply install this fork as local dependency of your project.
htmlextension for files is not used. Cleaner URLs: Remove html extension from URLs.
- heavy-weight dependency
requestis removed. Related functionality is broken, but it is not required for most users.
html extension is the main reason why fork is required. Netlify doesn't remove
.html extension from relative links like
So, it leads to numerous issues — duplicated pages in the search index (Google) and so on.
gitbook serve is not fixed to such URLs. Because due to number of issues
gitbook serve is slower than just
gitbook build and constantly running http-server (hint: use
-c-1 to disable caching). And
http-server supports URLs without
Node.js 8 is required to use.
Complete documentation is available at toolchain.gitbook.com.
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.
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
- Write using Markdown or AsciiDoc
- Output as a website or ebook (pdf, epub, mobi)
- Lexicon / Glossary
- Variables and Templating
- Content References
- Beautiful default theme
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.
GitBook is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.